org.yaml.snakeyaml.composer

Class Composer

java.lang.Object

org.yaml.snakeyaml.composer.Composer

public class Composer
extends java.lang.Object

Creates a node graph from parser events.

Corresponds to the 'Compose' step as described in chapter 3.1 of the YAML Specification.

Constructor Summary

Constructors

Constructor and Description
Composer(Parser parser, Resolver resolver)

Method Summary

Modifier and Type	Method and Description
boolean	checkNode() Checks if further documents are available.
Node	getNode() Reads and composes the next document.
Node	getSingleNode() Reads a document from a source that contains only one document.

Methods inherited from class java.lang.Object

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

Constructor Detail

Composer

public Composer(Parser parser,
                Resolver resolver)

Method Detail

checkNode

public boolean checkNode()

Checks if further documents are available.

Returns:

true if there is at least one more document.

getNode

public Node getNode()

Reads and composes the next document.

Returns:

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

getSingleNode

public 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 null if no document is available.