Package org.snakeyaml.engine.v2.representer

Class BaseRepresenter

java.lang.Object

org.snakeyaml.engine.v2.representer.BaseRepresenter

Direct Known Subclasses:

StandardRepresenter

public abstract class BaseRepresenter
extends Object

Represent basic YAML structures: scalar, sequence, mapping

Field Summary

Fields

Modifier and Type	Field	Description
protected FlowStyle	defaultFlowStyle	flow style for collections
protected ScalarStyle	defaultScalarStyle	scalar style
protected RepresentToNode	nullRepresenter	in Java 'null' is not a type.
protected Object	objectToRepresent	the current object to be converted to Node
protected Map<Class<?>,RepresentToNode>	parentClassRepresenters	Keep representers which match a parent of the class to be represented
protected Map<Object,org.snakeyaml.engine.v2.nodes.Node>	representedObjects	Keep references of already represented instances.
protected Map<Class<?>,RepresentToNode>	representers	Keep representers which must match the class exactly

Constructor Summary

Constructors

Constructor	Description
BaseRepresenter()

Method Summary

Modifier and Type	Method	Description
protected Optional<RepresentToNode>	findRepresenterFor(Object data)	Find the representer which is suitable to represent the internal structure of the provided instance to a Node
org.snakeyaml.engine.v2.nodes.Node	represent(Object data)	Represent the provided Java instance to a Node
protected org.snakeyaml.engine.v2.nodes.Node	representData(Object data)	Find the representer and use it to create the Node from instance
protected org.snakeyaml.engine.v2.nodes.Node	representMapping(org.snakeyaml.engine.v2.nodes.Tag tag, Map<?,?> mapping, FlowStyle flowStyle)	Create Node for the provided Map
protected org.snakeyaml.engine.v2.nodes.NodeTuple	representMappingEntry(Map.Entry<?,?> entry)	Create a tuple for one key pair
protected org.snakeyaml.engine.v2.nodes.Node	representScalar(org.snakeyaml.engine.v2.nodes.Tag tag, String value)	Create Node for string using PLAIN scalar style if possible
protected org.snakeyaml.engine.v2.nodes.Node	representScalar(org.snakeyaml.engine.v2.nodes.Tag tag, String value, ScalarStyle style)	Create Scalar Node from string
protected org.snakeyaml.engine.v2.nodes.Node	representSequence(org.snakeyaml.engine.v2.nodes.Tag tag, Iterable<?> sequence, FlowStyle flowStyle)	Create Node

Methods inherited from class java.lang.Object

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

Field Detail

representers

protected final Map<Class<?>,RepresentToNode> representers

Keep representers which must match the class exactly

parentClassRepresenters

protected final Map<Class<?>,RepresentToNode> parentClassRepresenters

Keep representers which match a parent of the class to be represented

representedObjects

protected final Map<Object,org.snakeyaml.engine.v2.nodes.Node> representedObjects

Keep references of already represented instances. The order is important (map can be also a sequence of key-values)

nullRepresenter

protected RepresentToNode nullRepresenter

in Java 'null' is not a type. So we have to keep the null representer separately

defaultScalarStyle

protected ScalarStyle defaultScalarStyle

scalar style

defaultFlowStyle

protected FlowStyle defaultFlowStyle

flow style for collections

objectToRepresent

protected Object objectToRepresent

the current object to be converted to Node

Constructor Detail

BaseRepresenter

public BaseRepresenter()

Method Detail

represent

public org.snakeyaml.engine.v2.nodes.Node represent(Object data)

Represent the provided Java instance to a Node

Parameters:

data - - Java instance to be represented

Returns:

The Node to be serialized

findRepresenterFor

protected Optional<RepresentToNode> findRepresenterFor(Object data)

Find the representer which is suitable to represent the internal structure of the provided instance to a Node

Parameters:

data - - the data to be serialized

Returns:

RepresentToNode to call to create a Node

representData

protected final org.snakeyaml.engine.v2.nodes.Node representData(Object data)

Find the representer and use it to create the Node from instance

Parameters:

data - - the source

Returns:

Node for the provided source

representScalar

protected org.snakeyaml.engine.v2.nodes.Node representScalar(org.snakeyaml.engine.v2.nodes.Tag tag,
                                                             String value,
                                                             ScalarStyle style)

Create Scalar Node from string

Parameters:

tag - - the tag in Node

value - - the source

style - - the style

Returns:

Node for string

representScalar

protected org.snakeyaml.engine.v2.nodes.Node representScalar(org.snakeyaml.engine.v2.nodes.Tag tag,
                                                             String value)

Create Node for string using PLAIN scalar style if possible

Parameters:

tag - - the tag for Node

value - - the surce

Returns:

Node for string

representSequence

protected org.snakeyaml.engine.v2.nodes.Node representSequence(org.snakeyaml.engine.v2.nodes.Tag tag,
                                                               Iterable<?> sequence,
                                                               FlowStyle flowStyle)

Create Node

Parameters:

tag - - tag to use in Node

sequence - - the source

flowStyle - - the flow style

Returns:

the Node from the source iterable

representMappingEntry

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

Create a tuple for one key pair

Parameters:

entry - - Map entry

Returns:

the tuple where both key and value are converted to Node

representMapping

protected org.snakeyaml.engine.v2.nodes.Node representMapping(org.snakeyaml.engine.v2.nodes.Tag tag,
                                                              Map<?,?> mapping,
                                                              FlowStyle flowStyle)

Create Node for the provided Map

Parameters:

tag - - the tag for Node

mapping - - the source

flowStyle - - the style of Node

Returns:

Node for the source Map