Package org.snakeyaml.engine.v2.api
Class Load
- java.lang.Object
-
- org.snakeyaml.engine.v2.api.Load
-
public class Load extends java.lang.Object
Common way to load Java instance(s). This class is not thread-safe. Which means that all the methods of the same instance can be called only by one thread. It is better to create an instance for every YAML stream. The instance is stateful. Only one of the 'load' methods may be called, and it may be called only once.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
Load.YamlIterable
private static class
Load.YamlIterator
-
Field Summary
Fields Modifier and Type Field Description private BaseConstructor
constructor
private LoadSettings
settings
-
Constructor Summary
Constructors Constructor Description Load(LoadSettings settings)
Create instance to parse the incoming YAML data and create Java instancesLoad(LoadSettings settings, BaseConstructor constructor)
Create instance to parse the incoming YAML data and create Java instances
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Composer
createComposer(java.io.InputStream yamlStream)
Create Composerprotected Composer
createComposer(java.io.Reader yamlReader)
Create Composerprotected Composer
createComposer(java.lang.String yaml)
Create Composerprivate Composer
createComposer(StreamReader streamReader)
Create Composerprivate java.lang.Iterable<java.lang.Object>
loadAll(Composer composer)
java.lang.Iterable<java.lang.Object>
loadAllFromInputStream(java.io.InputStream yamlStream)
Parse all YAML documents in a stream and produce corresponding Java objects.java.lang.Iterable<java.lang.Object>
loadAllFromReader(java.io.Reader yamlReader)
Parse all YAML documents in a String and produce corresponding Java objects.java.lang.Iterable<java.lang.Object>
loadAllFromString(java.lang.String yaml)
Parse all YAML documents in a String and produce corresponding Java objects.java.lang.Object
loadFromInputStream(java.io.InputStream yamlStream)
Parse the only YAML document in a stream and produce the corresponding Java object.java.lang.Object
loadFromReader(java.io.Reader yamlReader)
Parse a YAML document and create a Java instancejava.lang.Object
loadFromString(java.lang.String yaml)
Parse a YAML document and create a Java instanceprotected java.lang.Object
loadOne(Composer composer)
Load with provided Composer
-
-
-
Field Detail
-
settings
private final LoadSettings settings
-
constructor
private final BaseConstructor constructor
-
-
Constructor Detail
-
Load
public Load(LoadSettings settings)
Create instance to parse the incoming YAML data and create Java instances- Parameters:
settings
- - configuration
-
Load
public Load(LoadSettings settings, BaseConstructor constructor)
Create instance to parse the incoming YAML data and create Java instances- Parameters:
settings
- - configurationconstructor
- - custom YAML constructor
-
-
Method Detail
-
createComposer
private Composer createComposer(StreamReader streamReader)
Create Composer- Parameters:
streamReader
- - the input- Returns:
- configured Composer
-
createComposer
protected Composer createComposer(java.io.InputStream yamlStream)
Create Composer- Parameters:
yamlStream
- - the input- Returns:
- configured Composer
-
createComposer
protected Composer createComposer(java.lang.String yaml)
Create Composer- Parameters:
yaml
- - the input- Returns:
- configured Composer
-
createComposer
protected Composer createComposer(java.io.Reader yamlReader)
Create Composer- Parameters:
yamlReader
- - the input- Returns:
- configured Composer
-
loadOne
protected java.lang.Object loadOne(Composer composer)
Load with provided Composer- Parameters:
composer
- - the component to create the Node- Returns:
- deserialised YAML document
-
loadFromInputStream
public java.lang.Object loadFromInputStream(java.io.InputStream yamlStream)
Parse the only YAML document in a stream and produce the corresponding Java object.- Parameters:
yamlStream
- - data to load from (BOM is respected to detect encoding and removed from the data)- Returns:
- parsed Java instance
-
loadFromReader
public java.lang.Object loadFromReader(java.io.Reader yamlReader)
Parse a YAML document and create a Java instance- Parameters:
yamlReader
- - data to load from (BOM must not be present)- Returns:
- parsed Java instance
-
loadFromString
public java.lang.Object loadFromString(java.lang.String yaml)
Parse a YAML document and create a Java instance- Parameters:
yaml
- - YAML data to load from (BOM must not be present)- Returns:
- parsed Java instance
- Throws:
YamlEngineException
- if the YAML is not valid
-
loadAll
private java.lang.Iterable<java.lang.Object> loadAll(Composer composer)
-
loadAllFromInputStream
public java.lang.Iterable<java.lang.Object> loadAllFromInputStream(java.io.InputStream yamlStream)
Parse all YAML documents in a stream and produce corresponding Java objects. The documents are parsed only when the iterator is invoked.- Parameters:
yamlStream
- - YAML data to load from (BOM is respected to detect encoding and removed from the data)- Returns:
- an Iterable over the parsed Java objects in this stream in proper sequence
-
loadAllFromReader
public java.lang.Iterable<java.lang.Object> loadAllFromReader(java.io.Reader yamlReader)
Parse all YAML documents in a String and produce corresponding Java objects. The documents are parsed only when the iterator is invoked.- Parameters:
yamlReader
- - YAML data to load from (BOM must not be present)- Returns:
- an Iterable over the parsed Java objects in this stream in proper sequence
-
loadAllFromString
public java.lang.Iterable<java.lang.Object> loadAllFromString(java.lang.String yaml)
Parse all YAML documents in a String and produce corresponding Java objects. (Because the encoding in known BOM is not respected.) The documents are parsed only when the iterator is invoked.- Parameters:
yaml
- - YAML data to load from (BOM must not be present)- Returns:
- an Iterable over the parsed Java objects in this stream in proper sequence
-
-