Class Parse
- java.lang.Object
-
- org.snakeyaml.engine.v2.api.lowlevel.Parse
-
public class Parse extends java.lang.Object
Read the input stream and parse the content into events (opposite for Present or Emit)
-
-
Field Summary
Fields Modifier and Type Field Description private LoadSettings
settings
-
Constructor Summary
Constructors Constructor Description Parse(LoadSettings settings)
Create instance with providedLoadSettings
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Iterable<Event>
parseInputStream(java.io.InputStream yaml)
Parse a YAML stream and produce parsing events.java.lang.Iterable<Event>
parseReader(java.io.Reader yaml)
Parse a YAML stream and produce parsing events.java.lang.Iterable<Event>
parseString(java.lang.String yaml)
Parse a YAML stream and produce parsing events.
-
-
-
Field Detail
-
settings
private final LoadSettings settings
-
-
Constructor Detail
-
Parse
public Parse(LoadSettings settings)
Create instance with providedLoadSettings
- Parameters:
settings
- - configuration
-
-
Method Detail
-
parseInputStream
public java.lang.Iterable<Event> parseInputStream(java.io.InputStream yaml)
Parse a YAML stream and produce parsing events.- 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 events
- See Also:
- Processing Overview
-
parseReader
public java.lang.Iterable<Event> parseReader(java.io.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
- - YAML document(s).- Returns:
- parsed events
- See Also:
- Processing Overview
-
parseString
public java.lang.Iterable<Event> parseString(java.lang.String yaml)
Parse a YAML stream and produce parsing events.- Parameters:
yaml
- - YAML document(s). The BOM must not be present (it will be parsed as content)- Returns:
- parsed events
- See Also:
- Processing Overview
-
-