Package org.yaml.snakeyaml.representer

Class BaseRepresenter

java.lang.Object

org.yaml.snakeyaml.representer.BaseRepresenter

Direct Known Subclasses:

Representer

public abstract class BaseRepresenter
extends Object

Represent basic YAML structures: scalar, sequence, mapping

Field Summary

Fields

Modifier and Type	Field	Description
protected DumperOptions.FlowStyle	defaultFlowStyle	flow style to use if not redefined.
protected DumperOptions.ScalarStyle	defaultScalarStyle	default scalar style is PLAIN
protected Map<Class<?>,Represent>	multiRepresenters	represent class and its children with common code
protected Represent	nullRepresenter	in Java 'null' is not a type.
protected Object	objectToRepresent	object to create the Node for
protected Map<Object,Node>	representedObjects	Keep references of already represented instances
protected Map<Class<?>,Represent>	representers	represent the class without its subclasses

Constructor Summary

Constructors

Constructor	Description
BaseRepresenter()

Method Summary

Modifier and Type	Method	Description
DumperOptions.FlowStyle	getDefaultFlowStyle()	getter
DumperOptions.ScalarStyle	getDefaultScalarStyle()	getter
PropertyUtils	getPropertyUtils()	getter
boolean	isExplicitPropertyUtils()
Node	represent(Object data)
protected Node	representData(Object data)
protected Node	representMapping(Tag tag, Map<?,?> mapping, DumperOptions.FlowStyle flowStyle)
protected Node	representScalar(Tag tag, String value)
protected Node	representScalar(Tag tag, String value, DumperOptions.ScalarStyle style)	Create scalar node for the provided string object.
protected Node	representSequence(Tag tag, Iterable<?> sequence, DumperOptions.FlowStyle flowStyle)
void	setDefaultFlowStyle(DumperOptions.FlowStyle defaultFlowStyle)
void	setDefaultScalarStyle(DumperOptions.ScalarStyle defaultStyle)
void	setPropertyUtils(PropertyUtils propertyUtils)

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<?>,Represent> representers

represent the class without its subclasses

nullRepresenter

protected Represent nullRepresenter

in Java 'null' is not a type. So we have to keep the null representer separately otherwise it will coincide with the default representer which is stored with the key null.

multiRepresenters

protected final Map<Class<?>,Represent> multiRepresenters

represent class and its children with common code

defaultScalarStyle

protected DumperOptions.ScalarStyle defaultScalarStyle

default scalar style is PLAIN

defaultFlowStyle

protected DumperOptions.FlowStyle defaultFlowStyle

flow style to use if not redefined.

representedObjects

protected final Map<Object,Node> representedObjects

Keep references of already represented instances

objectToRepresent

protected Object objectToRepresent

object to create the Node for

Constructor Detail

BaseRepresenter

public BaseRepresenter()

Method Detail

represent

public Node represent(Object data)

representData

protected final Node representData(Object data)

representScalar

protected Node representScalar(Tag tag,
                               String value,
                               DumperOptions.ScalarStyle style)

Create scalar node for the provided string object.

Parameters:

tag - - the tag to emit

value - - the value to emit

style - - scalar style when preferred

Returns:

Node to emit

representScalar

protected Node representScalar(Tag tag,
                               String value)

representSequence

protected Node representSequence(Tag tag,
                                 Iterable<?> sequence,
                                 DumperOptions.FlowStyle flowStyle)

representMapping

protected Node representMapping(Tag tag,
                                Map<?,?> mapping,
                                DumperOptions.FlowStyle flowStyle)

setDefaultScalarStyle

public void setDefaultScalarStyle(DumperOptions.ScalarStyle defaultStyle)

getDefaultScalarStyle

public DumperOptions.ScalarStyle getDefaultScalarStyle()

getter

Returns:

scala style

setDefaultFlowStyle

public void setDefaultFlowStyle(DumperOptions.FlowStyle defaultFlowStyle)

getDefaultFlowStyle

public DumperOptions.FlowStyle getDefaultFlowStyle()

getter

Returns:

current flow style

setPropertyUtils

public void setPropertyUtils(PropertyUtils propertyUtils)

getPropertyUtils

public final PropertyUtils getPropertyUtils()

getter

Returns:

utils or create if null

isExplicitPropertyUtils

public final boolean isExplicitPropertyUtils()