org.yaml.snakeyaml.representer

Class Representer

java.lang.Object

org.yaml.snakeyaml.representer.BaseRepresenter

org.yaml.snakeyaml.representer.SafeRepresenter

org.yaml.snakeyaml.representer.Representer

public class Representer
extends SafeRepresenter

Represent JavaBeans

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Representer.RepresentJavaBean

Nested classes/interfaces inherited from class org.yaml.snakeyaml.representer.SafeRepresenter

SafeRepresenter.RepresentArray, SafeRepresenter.RepresentBoolean, SafeRepresenter.RepresentByteArray, SafeRepresenter.RepresentDate, SafeRepresenter.RepresentEnum, SafeRepresenter.RepresentIterator, SafeRepresenter.RepresentList, SafeRepresenter.RepresentMap, SafeRepresenter.RepresentNull, SafeRepresenter.RepresentNumber, SafeRepresenter.RepresentPrimitiveArray, SafeRepresenter.RepresentSet, SafeRepresenter.RepresentString, SafeRepresenter.RepresentUuid

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Class<? extends java.lang.Object>,TypeDescription>	typeDefinitions

Fields inherited from class org.yaml.snakeyaml.representer.SafeRepresenter

classTags, nonPrintableStyle, timeZone

Fields inherited from class org.yaml.snakeyaml.representer.BaseRepresenter

defaultFlowStyle, defaultScalarStyle, multiRepresenters, nullRepresenter, objectToRepresent, representedObjects, representers

Constructor Summary

Constructors

Constructor and Description
Representer()
Representer(DumperOptions options)

Method Summary

Modifier and Type	Method and Description
TypeDescription	addTypeDescription(TypeDescription td)
protected void	checkGlobalTag(Property property, Node node, java.lang.Object object) Remove redundant global tag for a type safe (generic) collection if it is the same as defined by the JavaBean property
protected java.util.Set<Property>	getProperties(java.lang.Class<? extends java.lang.Object> type) Get JavaBean properties to be serialised.
protected MappingNode	representJavaBean(java.util.Set<Property> properties, java.lang.Object javaBean) Tag logic: - explicit root tag is set in serializer - if there is a predefined class tag it is used - a global tag with class name is always used as tag.
protected NodeTuple	representJavaBeanProperty(java.lang.Object javaBean, Property property, java.lang.Object propertyValue, Tag customTag) Represent one JavaBean property.
private void	resetTag(java.lang.Class<? extends java.lang.Object> type, Node node)
void	setPropertyUtils(PropertyUtils propertyUtils)

Methods inherited from class org.yaml.snakeyaml.representer.SafeRepresenter

addClassTag, getTag, getTimeZone, setTimeZone

Methods inherited from class org.yaml.snakeyaml.representer.BaseRepresenter

getDefaultFlowStyle, getDefaultScalarStyle, getPropertyUtils, isExplicitPropertyUtils, represent, representData, representMapping, representScalar, representScalar, representSequence, setDefaultFlowStyle, setDefaultScalarStyle

Methods inherited from class java.lang.Object

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

Field Detail

typeDefinitions

protected java.util.Map<java.lang.Class<? extends java.lang.Object>,TypeDescription> typeDefinitions

Constructor Detail

Representer

public Representer()

Representer

public Representer(DumperOptions options)

Method Detail

addTypeDescription

public TypeDescription addTypeDescription(TypeDescription td)

setPropertyUtils

public void setPropertyUtils(PropertyUtils propertyUtils)

Overrides:

setPropertyUtils in class BaseRepresenter

representJavaBean

protected MappingNode representJavaBean(java.util.Set<Property> properties,
                                        java.lang.Object javaBean)

Tag logic: - explicit root tag is set in serializer - if there is a predefined class tag it is used - a global tag with class name is always used as tag. The JavaBean parent of the specified JavaBean may set another tag (tag:yaml.org,2002:map) when the property class is the same as runtime class

Parameters:

properties - JavaBean getters

javaBean - instance for Node

Returns:

Node to get serialized

representJavaBeanProperty

protected NodeTuple representJavaBeanProperty(java.lang.Object javaBean,
                                              Property property,
                                              java.lang.Object propertyValue,
                                              Tag customTag)

Represent one JavaBean property.

Parameters:

javaBean - - the instance to be represented

property - - the property of the instance

propertyValue - - value to be represented

customTag - - user defined Tag

Returns:

NodeTuple to be used in a MappingNode. Return null to skip the property

checkGlobalTag

protected void checkGlobalTag(Property property,
                              Node node,
                              java.lang.Object object)

Remove redundant global tag for a type safe (generic) collection if it is the same as defined by the JavaBean property

Parameters:

property - - JavaBean property

node - - representation of the property

object - - instance represented by the node

resetTag

private void resetTag(java.lang.Class<? extends java.lang.Object> type,
                      Node node)

getProperties

protected java.util.Set<Property> getProperties(java.lang.Class<? extends java.lang.Object> type)

Get JavaBean properties to be serialised. The order is respected. This method may be overridden to provide custom property selection or order.

Parameters:

type - - JavaBean to inspect the properties

Returns:

properties to serialise