SnakeYAML Engine 2.10 · org.snakeyaml.engine.v2.composer.Composer

Field Summary

Modifier and Type	Field and Description
private final Map<Anchor, Node>	anchors
private final CommentEventsCollector	blockCommentsCollector
private final CommentEventsCollector	inlineCommentsCollector
private final MergeUtils	mergeUtils
private int	nonScalarAliasesCount
protected final Parser	parser Event parser
private final Set<Node>	recursiveNodes
private final ScalarResolver	scalarResolver
private final LoadSettings	settings

Constructor Summary

Access	Constructor and Description
public	Composer(Parser - the input parser, LoadSettings - configuration options settings) Deprecated use the other constructor with LoadSettings first
public	Composer(LoadSettings - configuration options settings, Parser - the input parser) Create

Method Summary

Modifier and Type	Method and Description
protected MappingNode	asMappingNode(Node node)
protected Node	Returns: node composeKeyNode(MappingNode - the source node) To be able to override composeNode(node) which is a key
protected void	composeMappingChildren(List<NodeTuple> - the list to be extended children, MappingNode - the child to the children node) Add the provided Node to the children as the last child
protected Node	Returns: Node composeMappingNode(Optional<Anchor> - anchor if present anchor) Create mapping Node
private Node	composeNode(Optional<Node> parent)
protected Node	Returns: Node composeScalarNode(Optional<Anchor> - anchor if present anchor, List<CommentLine> - comments before the Node blockComments) Create ScalarNode
protected SequenceNode	Returns: parsed Node composeSequenceNode(Optional<Anchor> - anchor if present anchor) Compose a sequence Node from the input starting with SequenceStartEvent
protected Node	Returns: node composeValueNode(MappingNode - the source node) To be able to override composeNode(node) which is a value
public Optional<Node>	Returns: The root node of the document or `Optional.empty()` if no document is available. getSingleNode() Reads a document from a source that contains only one document.
public boolean	Returns: `true` if there is at least one more document. hasNext() Implements java.util.Iterator.hasNext. Checks if further documents are available.
public Node	Returns: The root node of the document or `null` if no more documents are available. next() Implements java.util.Iterator.next. Reads and composes the next document.
private void	registerAnchor(Anchor anchor, Node node)

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

Field Detail

anchors	back to summary
private final Map<Anchor, Node> anchors

blockCommentsCollector	back to summary
private final CommentEventsCollector blockCommentsCollector

inlineCommentsCollector	back to summary
private final CommentEventsCollector inlineCommentsCollector

mergeUtils	back to summary
private final MergeUtils mergeUtils

nonScalarAliasesCount	back to summary
private int nonScalarAliasesCount

parser	back to summary
protected final Parser parser Event parser

recursiveNodes	back to summary
private final Set<Node> recursiveNodes

scalarResolver	back to summary
private final ScalarResolver scalarResolver

settings	back to summary
private final LoadSettings settings

Constructor Detail

Composer	back to summary
public Composer(Parser parser, LoadSettings settings) Deprecated use the other constructor with LoadSettings first Parameters parser:Parser - the input settings:LoadSettings - configuration options Annotations @Deprecated

Composer	back to summary
public Composer(LoadSettings settings, Parser parser) Create Parameters settings:LoadSettings - configuration options parser:Parser - the input

Composer

back to summary

public Composer(LoadSettings settings, Parser parser)

Create

Parameters

settings:LoadSettings: - configuration options
parser:Parser: - the input

Method Detail

asMappingNode	back to summary
protected MappingNode asMappingNode(Node node)

composeKeyNode	back to summary
protected Node composeKeyNode(MappingNode node) To be able to override composeNode(node) which is a key Parameters node:MappingNode - the source Returns:Node node

composeKeyNode

back to summary

protected Node composeKeyNode(MappingNode node)

To be able to override composeNode(node) which is a key

Parameters

node:MappingNode: - the source

Returns:Node

node

composeMappingChildren	back to summary
protected void composeMappingChildren(List<NodeTuple> children, MappingNode node) Add the provided Node to the children as the last child Parameters children:List<NodeTuple> - the list to be extended node:MappingNode - the child to the children

composeMappingChildren

back to summary

protected void composeMappingChildren(List<NodeTuple> children, MappingNode node)

Add the provided Node to the children as the last child

Parameters

children:List<NodeTuple>: - the list to be extended
node:MappingNode: - the child to the children

composeMappingNode	back to summary
protected Node composeMappingNode(Optional<Anchor> anchor) Create mapping Node Parameters anchor:Optional<Anchor> - anchor if present Returns:Node Node

composeMappingNode

back to summary

protected Node composeMappingNode(Optional<Anchor> anchor)

Create mapping Node

Parameters

anchor:Optional<Anchor>: - anchor if present

Returns:Node

Node

composeNode	back to summary
private Node composeNode(Optional<Node> parent)

composeScalarNode	back to summary
protected Node composeScalarNode(Optional<Anchor> anchor, List<CommentLine> blockComments) Create ScalarNode Parameters anchor:Optional<Anchor> - anchor if present blockComments:List<CommentLine> - comments before the Node Returns:Node Node

composeScalarNode

back to summary

protected Node composeScalarNode(Optional<Anchor> anchor, List<CommentLine> blockComments)

Create ScalarNode

Parameters

anchor:Optional<Anchor>: - anchor if present
blockComments:List<CommentLine>: - comments before the Node

Returns:Node

Node

composeSequenceNode	back to summary
protected SequenceNode composeSequenceNode(Optional<Anchor> anchor) Compose a sequence Node from the input starting with SequenceStartEvent Parameters anchor:Optional<Anchor> - anchor if present Returns:SequenceNode parsed Node

composeSequenceNode

back to summary

protected SequenceNode composeSequenceNode(Optional<Anchor> anchor)

Compose a sequence Node from the input starting with SequenceStartEvent

Parameters

anchor:Optional<Anchor>: - anchor if present

Returns:SequenceNode

parsed Node

composeValueNode	back to summary
protected Node composeValueNode(MappingNode node) To be able to override composeNode(node) which is a value Parameters node:MappingNode - the source Returns:Node node

composeValueNode

back to summary

protected Node composeValueNode(MappingNode node)

To be able to override composeNode(node) which is a value

Parameters

node:MappingNode: - the source

Returns:Node

node

getSingleNode back to summary

getSingleNode	back to summary
public Optional<Node> getSingleNode() Reads a document from a source that contains only one document. If the stream contains more than one document an exception is thrown. Returns:Optional<Node> The root node of the document or `Optional.empty()` if no document is available.

public Optional<Node> getSingleNode()

Reads a document from a source that contains only one document.

If the stream contains more than one document an exception is thrown.

Returns:Optional<Node>: The root node of the document or Optional.empty() if no document is available.

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Checks if further documents are available. Returns:boolean `true` if there is at least one more document.

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Checks if further documents are available.

Returns:boolean: true if there is at least one more document.

next back to summary

next	back to summary
public Node next() Implements java.util.Iterator.next. Reads and composes the next document. Returns:Node The root node of the document or `null` if no more documents are available.

public Node next()

Implements java.util.Iterator.next.

Reads and composes the next document.

Returns:Node: The root node of the document or null if no more documents are available.

registerAnchor	back to summary
private void registerAnchor(Anchor anchor, Node node)

public Class Composer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail