Class Compose

java.lang.Object

org.snakeyaml.engine.v2.api.lowlevel.Compose

public class Compose
extends Object

Helper to compose input stream to Node

Field Summary

Fields

Modifier and Type	Field	Description
private final LoadSettings	settings

Constructor Summary

Constructors

Constructor	Description
Compose(LoadSettings settings)	Create instance with provided LoadSettings

Method Summary

Modifier and Type	Method	Description
Iterable<Node>	composeAllFromInputStream(InputStream yaml)	Parse all YAML documents in a stream and produce corresponding representation trees.
Iterable<Node>	composeAllFromReader(Reader yaml)	Parse all YAML documents in a stream and produce corresponding representation trees.
Iterable<Node>	composeAllFromString(String yaml)	Parse all YAML documents in a stream and produce corresponding representation trees.
Optional<Node>	composeInputStream(InputStream yaml)	Parse a YAML stream and produce Node
Optional<Node>	composeReader(Reader yaml)	Parse a YAML stream and produce Node
Optional<Node>	composeString(String yaml)	Parse a YAML stream and produce Node

Methods inherited from class Object

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

Field Details

settings

private final LoadSettings settings

Constructor Details

Compose

public Compose(LoadSettings settings)

Create instance with provided LoadSettings

Parameters:

settings - - configuration

Method Details

composeReader

public Optional<Node> composeReader(Reader yaml)

Parse a YAML stream and produce Node

Parameters:

yaml - - YAML document(s). Since the encoding is already known the BOM must not be present (it will be parsed as content)

Returns:

parsed Node if available

See Also:

• Processing Overview

composeInputStream

public Optional<Node> composeInputStream(InputStream yaml)

Parse a YAML stream and produce Node

Parameters:

yaml - - YAML document(s). Default encoding is UTF-8. The BOM must be present if the encoding is UTF-16 or UTF-32

Returns:

parsed Node if available

See Also:

• Processing Overview

composeString

public Optional<Node> composeString(String yaml)

Parse a YAML stream and produce Node

Parameters:

yaml - - YAML document(s).

Returns:

parsed Node if available

See Also:

• Processing Overview

composeAllFromReader

public Iterable<Node> composeAllFromReader(Reader yaml)

Parse all YAML documents in a stream and produce corresponding representation trees.

Parameters:

yaml - stream of YAML documents

Returns:

parsed root Nodes for all the specified YAML documents

See Also:

• Processing Overview

composeAllFromInputStream

public Iterable<Node> composeAllFromInputStream(InputStream yaml)

Parse all YAML documents in a stream and produce corresponding representation trees.

Parameters:

yaml - - YAML document(s). Default encoding is UTF-8. The BOM must be present if the encoding is UTF-16 or UTF-32

Returns:

parsed root Nodes for all the specified YAML documents

See Also:

• Processing Overview

composeAllFromString

public Iterable<Node> composeAllFromString(String yaml)

Parse all YAML documents in a stream and produce corresponding representation trees.

Parameters:

yaml - - YAML document(s).

Returns:

parsed root Nodes for all the specified YAML documents

See Also:

• Processing Overview