Top Description Fields Constructors Methods
org.snakeyaml.engine.v2.api.lowlevel

public Class Parse

extends Object
Class Inheritance
Imports
java.io.InputStream, .Reader, .StringReader, java.util.Iterator, .Objects, org.snakeyaml.engine.v2.api.LoadSettings, .YamlUnicodeReader, org.snakeyaml.engine.v2.events.Event, org.snakeyaml.engine.v2.parser.ParserImpl, org.snakeyaml.engine.v2.scanner.StreamReader

Read the input stream and parse the content into events (opposite for Present or Emit)

Field Summary

Modifier and TypeField and Description
private final LoadSettings

Constructor Summary

AccessConstructor and Description
public
Parse(LoadSettings
- configuration
settings
)

Create instance with provided LoadSettings

Method Summary

Modifier and TypeMethod and Description
public Iterable<Event>

Returns:

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

Parse a YAML stream and produce parsing events.

public Iterable<Event>

Returns:

parsed events
parseReader
(Reader
- YAML document(s).
yaml
)

Parse a YAML stream and produce parsing events.

public Iterable<Event>

Returns:

parsed events
parseString
(String
- YAML document(s). The BOM must not be present (it will be parsed as content)
yaml
)

Parse a YAML stream and produce parsing events.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

settingsback to summary
private final LoadSettings settings

Constructor Detail

Parseback to summary
public Parse(LoadSettings settings)

Create instance with provided LoadSettings

Parameters
settings:LoadSettings

- configuration

Method Detail

parseInputStreamback to summary
public Iterable<Event> parseInputStream(InputStream yaml)

Parse a YAML stream and produce parsing events.

Parameters
yaml:InputStream

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

Returns:Iterable<Event>

parsed events

See Also
Processing Overview
parseReaderback to summary
public Iterable<Event> parseReader(Reader yaml)

Parse a YAML stream and produce parsing events. Since the encoding is already known the BOM must not be present (it will be parsed as content)

Parameters
yaml:Reader

- YAML document(s).

Returns:Iterable<Event>

parsed events

See Also
Processing Overview
parseStringback to summary
public Iterable<Event> parseString(String yaml)

Parse a YAML stream and produce parsing events.

Parameters
yaml:String

- YAML document(s). The BOM must not be present (it will be parsed as content)

Returns:Iterable<Event>

parsed events

See Also
Processing Overview