dev.dejvokep.boostedyaml.engine

Class ExtendedRepresenter

java.lang.Object

org.snakeyaml.engine.v2.representer.BaseRepresenter

org.snakeyaml.engine.v2.representer.StandardRepresenter

dev.dejvokep.boostedyaml.engine.ExtendedRepresenter

public class ExtendedRepresenter
extends org.snakeyaml.engine.v2.representer.StandardRepresenter

A custom representer for the SnakeYAML Engine allowing to represent Section objects, serializing custom objects, all of which while keeping comments and without any additional time consumption.

Nested Class Summary

Nested classes/interfaces inherited from class org.snakeyaml.engine.v2.representer.StandardRepresenter

org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentArray, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentBoolean, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentByteArray, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentEnum, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentIterator, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentList, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentMap, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentNull, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentNumber, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentOptional, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentPrimitiveArray, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentSet, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentString, org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentUuid

Field Summary

Fields inherited from class org.snakeyaml.engine.v2.representer.StandardRepresenter

classTags, MULTILINE_PATTERN, settings

Fields inherited from class org.snakeyaml.engine.v2.representer.BaseRepresenter

defaultFlowStyle, defaultScalarStyle, nullRepresenter, objectToRepresent, parentClassRepresenters, representedObjects, representers

Constructor Summary

Constructors

Constructor and Description
ExtendedRepresenter(GeneralSettings generalSettings, org.snakeyaml.engine.v2.api.DumpSettings dumpSettings) Creates an instance of the representer.

Method Summary

Modifier and Type	Method and Description
org.snakeyaml.engine.v2.nodes.Node	applyKeyComments(Block<?> block, org.snakeyaml.engine.v2.nodes.Node node) Applies the given block's (if not null) key comments to the given node and returns the given node itself.
org.snakeyaml.engine.v2.nodes.Node	applyValueComments(Block<?> block, org.snakeyaml.engine.v2.nodes.Node node) Applies the given block's (if not null) value comments to the given node and returns the given node itself.
protected org.snakeyaml.engine.v2.nodes.NodeTuple	representMappingEntry(Map.Entry<?,?> entry)

Methods inherited from class org.snakeyaml.engine.v2.representer.StandardRepresenter

addClassTag, getTag

Methods inherited from class org.snakeyaml.engine.v2.representer.BaseRepresenter

findRepresenterFor, represent, representData, representMapping, representScalar, representScalar, representSequence

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtendedRepresenter

public ExtendedRepresenter(@NotNull
                           GeneralSettings generalSettings,
                           @NotNull
                           org.snakeyaml.engine.v2.api.DumpSettings dumpSettings)

Creates an instance of the representer.

Parameters:

generalSettings - general settings of the root's file, whose contents are going to be represented

dumpSettings - dumper settings

Method Detail

applyKeyComments

@NotNull
public org.snakeyaml.engine.v2.nodes.Node applyKeyComments(@Nullable
                                                                     Block<?> block,
                                                                     @NotNull
                                                                     org.snakeyaml.engine.v2.nodes.Node node)

Applies the given block's (if not null) key comments to the given node and returns the given node itself.

Parameters:

block - the block whose key comments to apply

node - node to apply the comments to

Returns:

the given node

applyValueComments

@NotNull
public org.snakeyaml.engine.v2.nodes.Node applyValueComments(@Nullable
                                                                       Block<?> block,
                                                                       @NotNull
                                                                       org.snakeyaml.engine.v2.nodes.Node node)

Applies the given block's (if not null) value comments to the given node and returns the given node itself.

Parameters:

block - the block whose value comments to apply

node - node to apply the comments to

Returns:

the given node

representMappingEntry

protected org.snakeyaml.engine.v2.nodes.NodeTuple representMappingEntry(Map.Entry<?,?> entry)

Overrides:

representMappingEntry in class org.snakeyaml.engine.v2.representer.BaseRepresenter