org.snakeyaml.engine.v2.composer

Class Composer

java.lang.Object

org.snakeyaml.engine.v2.composer.Composer

All Implemented Interfaces:

Iterator<org.snakeyaml.engine.v2.nodes.Node>

public class Composer
extends Object
implements Iterator<org.snakeyaml.engine.v2.nodes.Node>

Creates a node graph from parser events.

Corresponds to the 'Composer' step as described in chapter 3.1.2 of the YAML Specification.

It implements Iterator to get the stream of Nodes from the input.

Field Summary

Fields

Modifier and Type	Field and Description
protected Parser	parser Event parser

Constructor Summary

Constructors

Constructor and Description
Composer(LoadSettings settings, Parser parser) Create
Composer(Parser parser, LoadSettings settings) Deprecated. use the other constructor with LoadSettings first

Method Summary

Modifier and Type	Method and Description
protected org.snakeyaml.engine.v2.nodes.Node	composeKeyNode(org.snakeyaml.engine.v2.nodes.MappingNode node) To be able to override composeNode(node) which is a key
protected void	composeMappingChildren(List<org.snakeyaml.engine.v2.nodes.NodeTuple> children, org.snakeyaml.engine.v2.nodes.MappingNode node) Add the provided Node to the children as the last child
protected org.snakeyaml.engine.v2.nodes.Node	composeMappingNode(Optional<Anchor> anchor) Create mapping Node
protected org.snakeyaml.engine.v2.nodes.Node	composeScalarNode(Optional<Anchor> anchor, List<CommentLine> blockComments) Create ScalarNode
protected org.snakeyaml.engine.v2.nodes.SequenceNode	composeSequenceNode(Optional<Anchor> anchor) Compose a sequence Node from the input starting with SequenceStartEvent
protected org.snakeyaml.engine.v2.nodes.Node	composeValueNode(org.snakeyaml.engine.v2.nodes.MappingNode node) To be able to override composeNode(node) which is a value
Optional<org.snakeyaml.engine.v2.nodes.Node>	getSingleNode() Reads a document from a source that contains only one document.
boolean	hasNext() Checks if further documents are available.
org.snakeyaml.engine.v2.nodes.Node	next() Reads and composes the next document.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

parser

protected final Parser parser

Event parser

Constructor Detail

Composer

@Deprecated
public Composer(Parser parser,
                            LoadSettings settings)

Deprecated. use the other constructor with LoadSettings first

Parameters:

parser - - the input

settings - - configuration options

Composer

public Composer(LoadSettings settings,
                Parser parser)

Create

Parameters:

settings - - configuration options

parser - - the input

Method Detail

hasNext

public boolean hasNext()

Checks if further documents are available.

Specified by:

hasNext in interface Iterator<org.snakeyaml.engine.v2.nodes.Node>

Returns:

true if there is at least one more document.

getSingleNode

public Optional<org.snakeyaml.engine.v2.nodes.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:

The root node of the document or Optional.empty() if no document is available.

next

public org.snakeyaml.engine.v2.nodes.Node next()

Reads and composes the next document.

Specified by:

next in interface Iterator<org.snakeyaml.engine.v2.nodes.Node>

Returns:

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

composeScalarNode

protected org.snakeyaml.engine.v2.nodes.Node composeScalarNode(Optional<Anchor> anchor,
                                                               List<CommentLine> blockComments)

Create ScalarNode

Parameters:

anchor - - anchor if present

blockComments - - comments before the Node

Returns:

Node

composeSequenceNode

protected org.snakeyaml.engine.v2.nodes.SequenceNode composeSequenceNode(Optional<Anchor> anchor)

Compose a sequence Node from the input starting with SequenceStartEvent

Parameters:

anchor - - anchor if present

Returns:

parsed Node

composeMappingNode

protected org.snakeyaml.engine.v2.nodes.Node composeMappingNode(Optional<Anchor> anchor)

Create mapping Node

Parameters:

anchor - - anchor if present

Returns:

Node

composeMappingChildren

protected void composeMappingChildren(List<org.snakeyaml.engine.v2.nodes.NodeTuple> children,
                                      org.snakeyaml.engine.v2.nodes.MappingNode node)

Add the provided Node to the children as the last child

Parameters:

children - - the list to be extended

node - - the child to the children

composeKeyNode

protected org.snakeyaml.engine.v2.nodes.Node composeKeyNode(org.snakeyaml.engine.v2.nodes.MappingNode node)

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

Parameters:

node - - the source

Returns:

node

composeValueNode

protected org.snakeyaml.engine.v2.nodes.Node composeValueNode(org.snakeyaml.engine.v2.nodes.MappingNode node)

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

Parameters:

node - - the source

Returns:

node