SnakeYAML 2.2 · org.yaml.snakeyaml.constructor.BaseConstructor

Modifier and Type	Class and Description
private static class	BaseConstructor.RecursiveTuple<T, K>

Field Summary

Modifier and Type	Field and Description
private boolean	allowDuplicateKeys
protected Composer	composer No graph creator
pack-priv final Map<Node, Object>	constructedObjects
private boolean	enumCaseSensitive
private boolean	explicitPropertyUtils
protected LoaderOptions	loadingConfig options
private final ArrayList<BaseConstructor.RecursiveTuple<Map<Object, Object>, BaseConstructor.RecursiveTuple<Object, Object>>>	maps2fill
protected static final Object	NOT_INSTANTIATED_OBJECT An instance returned by newInstance methods when instantiation has not been performed.
private PropertyUtils	propertyUtils
private final Set<Node>	recursiveObjects
protected Tag	rootTag the tag for the root node
private final ArrayList<BaseConstructor.RecursiveTuple<Set<Object>, Object>>	sets2fill
protected final Map<Class<? extends Object>, TypeDescription>	typeDefinitions Mapping from a class to its manager
protected final Map<Tag, Class<? extends Object>>	typeTags register classes for tags
private boolean	wrappedToRootException
protected final Map<NodeId, Construct>	yamlClassConstructors It maps the node kind to the Construct implementation.
protected final Map<Tag, Construct>	yamlConstructors It maps the (explicit or implicit) tag to the Construct implementation.
protected final Map<String, Construct>	yamlMultiConstructors It maps the (explicit or implicit) tag to the Construct implementation.

Constructor Summary

Access	Constructor and Description
public	BaseConstructor(LoaderOptions - options loadingConfig) Create

Method Summary

Modifier and Type	Method and Description
public TypeDescription	Returns: the previous value associated with `definition`, or `null` if there was no mapping for `definition`. addTypeDescription(TypeDescription to be added to the Constructor definition) Make YAML aware how to parse a custom Class.
public boolean	Returns: true when there are more YAML documents in the stream checkData() Check if more documents available
protected Object	Returns: constructed array constructArray(SequenceNode - sequence node) Create array from sequence
protected Object	Returns: filled array constructArrayStep2(SequenceNode - the source node, Object - the destination array) Fill array from node
protected final Object	Returns: Java instance constructDocument(Node root Node node) Construct complete YAML document.
protected Map<Object, Object>	Returns: constructed Map constructMapping(MappingNode - mapping node) Create Map from mapping
protected void	constructMapping2ndStep(MappingNode - source node, Map<Object, Object> - map to fill mapping) Fill provided Map with constructed data
protected Object	Returns: Java instance constructObject(Node Node to be constructed node) Construct object from the specified Node.
protected Object	Returns: constructed instance constructObjectNoCheck(Node - the source node) Construct object from the specified Node without the check if it was already created.
protected String	Returns: the data constructScalar(ScalarNode - the source node) Create string from scalar
protected List<? extends Object>	Returns: filled List constructSequence(SequenceNode - the source node) Create List and fill it with data
protected void	constructSequenceStep2(SequenceNode - the source node, Collection<Object> - data to fill collection) Fill the provided collection with the data from the Node
protected Set<? extends Object>	Returns: constructed Set constructSet(SequenceNode - sequence node) create Set from sequence
protected Set<Object>	Returns: constructed Set constructSet(MappingNode - mapping node) Create Set from mapping
protected void	constructSet2ndStep(MappingNode node, Set<Object> set)
protected Object	createArray(Class<?> type, int size)
protected List<Object>	createDefaultList(int initSize)
protected Map<Object, Object>	createDefaultMap(int initSize)
protected Set<Object>	createDefaultSet(int initSize)
private void	fillRecursive() Fill the recursive structures and clean the internal collections
protected Object	finalizeConstruction(Node node, Object data)
protected Construct	Returns: `Construct` implementation for the specified node getConstructor(Node `Node` to construct an instance from node) Get the constructor to construct the Node.
public Object	Returns: constructed instance getData() Construct and return the next document
public LoaderOptions	getLoadingConfig()
public final PropertyUtils	getPropertyUtils()
public Object	Returns: constructed instance getSingleData(Class<?> the class of the instance being created type) Ensure that the stream contains a single document and construct it
public boolean	isAllowDuplicateKeys()
public boolean	isEnumCaseSensitive()
public final boolean	isExplicitPropertyUtils()
public boolean	isWrappedToRootException()
protected Object	newInstance(Node node)
protected final Object	newInstance(Class<?> ancestor, Node node)
protected Object	Returns: - a new object created for `node.getType()` by using corresponding TypeDescription.newInstance or default constructor. - `NOT_INSTANTIATED_OBJECT` in case no object has been created newInstance(Class<?> expected ancestor of the `node.getType()` ancestor, Node for which to create a corresponding java object node, boolean should default constructor to be tried when there is no corresponding `TypeDescription` or `TypeDescription.newInstance(node)` returns `null`. tryDefault) Tries to create a new object for the node.
protected List<Object>	newList(SequenceNode node)
protected Map<Object, Object>	newMap(MappingNode node)
protected Set<Object>	newSet(CollectionNode<?> node)
protected void	postponeMapFilling(Map<Object, Object> mapping, Object key, Object value)
protected void	postponeSetFilling(Set<Object> set, Object key)
public void	setAllowDuplicateKeys(boolean allowDuplicateKeys)
public void	setComposer(Composer composer)
public void	setEnumCaseSensitive(boolean enumCaseSensitive)
public void	setPropertyUtils(PropertyUtils propertyUtils)
public void	setWrappedToRootException(boolean wrappedToRootException)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowDuplicateKeys	back to summary
private boolean allowDuplicateKeys

composer	back to summary
protected Composer composer No graph creator

constructedObjects	back to summary
pack-priv final Map<Node, Object> constructedObjects

enumCaseSensitive	back to summary
private boolean enumCaseSensitive

explicitPropertyUtils	back to summary
private boolean explicitPropertyUtils

loadingConfig	back to summary
protected LoaderOptions loadingConfig options

maps2fill	back to summary
private final ArrayList<BaseConstructor.RecursiveTuple<Map<Object, Object>, BaseConstructor.RecursiveTuple<Object, Object>>> maps2fill

NOT_INSTANTIATED_OBJECT	back to summary
protected static final Object NOT_INSTANTIATED_OBJECT An instance returned by newInstance methods when instantiation has not been performed.

propertyUtils	back to summary
private PropertyUtils propertyUtils

recursiveObjects	back to summary
private final Set<Node> recursiveObjects

rootTag	back to summary
protected Tag rootTag the tag for the root node

sets2fill	back to summary
private final ArrayList<BaseConstructor.RecursiveTuple<Set<Object>, Object>> sets2fill

typeDefinitions	back to summary
protected final Map<Class<? extends Object>, TypeDescription> typeDefinitions Mapping from a class to its manager

typeTags	back to summary
protected final Map<Tag, Class<? extends Object>> typeTags register classes for tags

wrappedToRootException	back to summary
private boolean wrappedToRootException

yamlClassConstructors	back to summary
protected final Map<NodeId, Construct> yamlClassConstructors It maps the node kind to the Construct implementation. When the runtime class is known then the implicit tag is ignored.

yamlConstructors	back to summary
protected final Map<Tag, Construct> yamlConstructors It maps the (explicit or implicit) tag to the Construct implementation. It is used: 1) explicit tag - if present. 2) implicit tag - when the runtime class of the instance is unknown (the node has the Object.class) 3) when nothing else is found the Construct for the key 'null' is chosen (which is ConstructYamlObject)

yamlMultiConstructors	back to summary
protected final Map<String, Construct> yamlMultiConstructors It maps the (explicit or implicit) tag to the Construct implementation. It is used when no exact match found. The key in the Map is checked if it starts the class name

Constructor Detail

BaseConstructor	back to summary
public BaseConstructor(LoaderOptions loadingConfig) Create Parameters loadingConfig:LoaderOptions - options

BaseConstructor

back to summary

public BaseConstructor(LoaderOptions loadingConfig)

Create

Parameters

loadingConfig:LoaderOptions: - options

Method Detail

addTypeDescription back to summary

addTypeDescription	back to summary
public TypeDescription addTypeDescription(TypeDescription definition) Make YAML aware how to parse a custom Class. If there is no root Class assigned in constructor then the 'root' property of this definition is respected. Parameters definition:TypeDescription to be added to the Constructor Returns:TypeDescription the previous value associated with `definition`, or `null` if there was no mapping for `definition`.

public TypeDescription addTypeDescription(TypeDescription definition)

Make YAML aware how to parse a custom Class. If there is no root Class assigned in constructor then the 'root' property of this definition is respected.

Parameters

definition:TypeDescription: to be added to the Constructor

Returns:TypeDescription

the previous value associated with definition, or null if there was no mapping for definition.

checkData	back to summary
public boolean checkData() Check if more documents available Returns:boolean true when there are more YAML documents in the stream

checkData

back to summary

public boolean checkData()

Check if more documents available

Returns:boolean: true when there are more YAML documents in the stream

constructArray	back to summary
protected Object constructArray(SequenceNode node) Create array from sequence Parameters node:SequenceNode - sequence Returns:Object constructed array

constructArray

back to summary

protected Object constructArray(SequenceNode node)

Create array from sequence

Parameters

node:SequenceNode: - sequence

Returns:Object

constructed array

constructArrayStep2	back to summary
protected Object constructArrayStep2(SequenceNode node, Object array) Fill array from node Parameters node:SequenceNode - the source array:Object - the destination Returns:Object filled array

constructArrayStep2

back to summary

protected Object constructArrayStep2(SequenceNode node, Object array)

Fill array from node

Parameters

node:SequenceNode: - the source
array:Object: - the destination

Returns:Object

filled array

constructDocument	back to summary
protected final Object constructDocument(Node node) Construct complete YAML document. Call the second step in case of recursive structures. At the end cleans all the state. Parameters node:Node root Node Returns:Object Java instance

constructDocument

back to summary

protected final Object constructDocument(Node node)

Construct complete YAML document. Call the second step in case of recursive structures. At the end cleans all the state.

Parameters

node:Node: root Node

Returns:Object

Java instance

constructMapping	back to summary
protected Map<Object, Object> constructMapping(MappingNode node) Create Map from mapping Parameters node:MappingNode - mapping Returns:Map<Object, Object> constructed Map

constructMapping

back to summary

protected Map<Object, Object> constructMapping(MappingNode node)

Create Map from mapping

Parameters

node:MappingNode: - mapping

Returns:Map<Object, Object>

constructed Map

constructMapping2ndStep	back to summary
protected void constructMapping2ndStep(MappingNode node, Map<Object, Object> mapping) Fill provided Map with constructed data Parameters node:MappingNode - source mapping:Map<Object, Object> - map to fill

constructMapping2ndStep

back to summary

protected void constructMapping2ndStep(MappingNode node, Map<Object, Object> mapping)

Fill provided Map with constructed data

Parameters

node:MappingNode: - source
mapping:Map<Object, Object>: - map to fill

constructObject	back to summary
protected Object constructObject(Node node) Construct object from the specified Node. Return existing instance if the node is already constructed. Parameters node:Node Node to be constructed Returns:Object Java instance

constructObject

back to summary

protected Object constructObject(Node node)

Construct object from the specified Node. Return existing instance if the node is already constructed.

Parameters

node:Node: Node to be constructed

Returns:Object

Java instance

constructObjectNoCheck	back to summary
protected Object constructObjectNoCheck(Node node) Construct object from the specified Node without the check if it was already created. Parameters node:Node - the source Returns:Object constructed instance

constructObjectNoCheck

back to summary

protected Object constructObjectNoCheck(Node node)

Construct object from the specified Node without the check if it was already created.

Parameters

node:Node: - the source

Returns:Object

constructed instance

constructScalar	back to summary
protected String constructScalar(ScalarNode node) Create string from scalar Parameters node:ScalarNode - the source Returns:String the data

constructScalar

back to summary

protected String constructScalar(ScalarNode node)

Create string from scalar

Parameters

node:ScalarNode: - the source

Returns:String

the data

constructSequence	back to summary
protected List<? extends Object> constructSequence(SequenceNode node) Create List and fill it with data Parameters node:SequenceNode - the source Returns:List<? extends Object> filled List

constructSequence

back to summary

protected List<? extends Object> constructSequence(SequenceNode node)

Create List and fill it with data

Parameters

node:SequenceNode: - the source

Returns:List<? extends Object>

filled List

constructSequenceStep2	back to summary
protected void constructSequenceStep2(SequenceNode node, Collection<Object> collection) Fill the provided collection with the data from the Node Parameters node:SequenceNode - the source collection:Collection<Object> - data to fill

constructSequenceStep2

back to summary

protected void constructSequenceStep2(SequenceNode node, Collection<Object> collection)

Fill the provided collection with the data from the Node

Parameters

node:SequenceNode: - the source
collection:Collection<Object>: - data to fill

constructSet	back to summary
protected Set<? extends Object> constructSet(SequenceNode node) create Set from sequence Parameters node:SequenceNode - sequence Returns:Set<? extends Object> constructed Set

constructSet

back to summary

protected Set<? extends Object> constructSet(SequenceNode node)

create Set from sequence

Parameters

node:SequenceNode: - sequence

Returns:Set<? extends Object>

constructed Set

constructSet	back to summary
protected Set<Object> constructSet(MappingNode node) Create Set from mapping Parameters node:MappingNode - mapping Returns:Set<Object> constructed Set

constructSet

back to summary

protected Set<Object> constructSet(MappingNode node)

Create Set from mapping

Parameters

node:MappingNode: - mapping

Returns:Set<Object>

constructed Set

constructSet2ndStep	back to summary
protected void constructSet2ndStep(MappingNode node, Set<Object> set)

createArray	back to summary
protected Object createArray(Class<?> type, int size)

createDefaultList	back to summary
protected List<Object> createDefaultList(int initSize)

createDefaultMap	back to summary
protected Map<Object, Object> createDefaultMap(int initSize)

createDefaultSet	back to summary
protected Set<Object> createDefaultSet(int initSize)

fillRecursive	back to summary
private void fillRecursive() Fill the recursive structures and clean the internal collections

finalizeConstruction	back to summary
protected Object finalizeConstruction(Node node, Object data)

getConstructor back to summary

getConstructor	back to summary
protected Construct getConstructor(Node node) Get the constructor to construct the Node. For implicit tags if the runtime class is known a dedicated Construct implementation is used. Otherwise, the constructor is chosen by the tag. Parameters node:Node `Node` to construct an instance from Returns:Construct `Construct` implementation for the specified node

protected Construct getConstructor(Node node)

Get the constructor to construct the Node. For implicit tags if the runtime class is known a dedicated Construct implementation is used. Otherwise, the constructor is chosen by the tag.

Parameters

node:Node: Node to construct an instance from

Returns:Construct

Construct implementation for the specified node

getData	back to summary
public Object getData() throws NoSuchElementException Construct and return the next document Returns:Object constructed instance

getData

back to summary

public Object getData() throws NoSuchElementException

Construct and return the next document

Returns:Object: constructed instance

getLoadingConfig	back to summary
public LoaderOptions getLoadingConfig()

getPropertyUtils	back to summary
public final PropertyUtils getPropertyUtils()

getSingleData	back to summary
public Object getSingleData(Class<?> type) Ensure that the stream contains a single document and construct it Parameters type:Class<?> the class of the instance being created Returns:Object constructed instance Exceptions ComposerException: in case there are more documents in the stream

getSingleData

back to summary

public Object getSingleData(Class<?> type)

Ensure that the stream contains a single document and construct it

Parameters

type:Class<?>: the class of the instance being created

Returns:Object

constructed instance

Exceptions

ComposerException:: in case there are more documents in the stream

isAllowDuplicateKeys	back to summary
public boolean isAllowDuplicateKeys()

isEnumCaseSensitive	back to summary
public boolean isEnumCaseSensitive()

isExplicitPropertyUtils	back to summary
public final boolean isExplicitPropertyUtils()

isWrappedToRootException	back to summary
public boolean isWrappedToRootException()

newInstance	back to summary
protected Object newInstance(Node node)

newInstance	back to summary
protected final Object newInstance(Class<?> ancestor, Node node)

newInstance back to summary

protected Object newInstance(Class<?> ancestor, Node node, boolean tryDefault)

Tries to create a new object for the node.

Parameters

ancestor:Class<?>: expected ancestor of the node.getType()
node:Node: for which to create a corresponding java object
tryDefault:boolean: should default constructor to be tried when there is no corresponding TypeDescription or TypeDescription.newInstance(node) returns null.

Returns:Object

- a new object created for node.getType() by using corresponding TypeDescription.newInstance or default constructor. - NOT_INSTANTIATED_OBJECT in case no object has been created

newList	back to summary
protected List<Object> newList(SequenceNode node) Annotations @SuppressWarnings:unchecked

newMap	back to summary
protected Map<Object, Object> newMap(MappingNode node) Annotations @SuppressWarnings:unchecked

newSet	back to summary
protected Set<Object> newSet(CollectionNode<?> node) Annotations @SuppressWarnings:unchecked

postponeMapFilling	back to summary
protected void postponeMapFilling(Map<Object, Object> mapping, Object key, Object value)

postponeSetFilling	back to summary
protected void postponeSetFilling(Set<Object> set, Object key)

setAllowDuplicateKeys	back to summary
public void setAllowDuplicateKeys(boolean allowDuplicateKeys)

setComposer	back to summary
public void setComposer(Composer composer)

setEnumCaseSensitive	back to summary
public void setEnumCaseSensitive(boolean enumCaseSensitive)

setPropertyUtils	back to summary
public void setPropertyUtils(PropertyUtils propertyUtils)

setWrappedToRootException	back to summary
public void setWrappedToRootException(boolean wrappedToRootException)

Modifier and Type	Field and Description
private final T	_1
private final K	_2

public abstract Class BaseConstructor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BaseConstructor.RecursiveTuple<T, K>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail