Modifier and Type	Class and Description
private static class	Load.YamlIterable
private static class	Load.YamlIterator

Modifier and Type	Field and Description
private final BaseConstructor	constructor
private final LoadSettings	settings

Access	Constructor and Description
public	Load(LoadSettings - configuration settings) Create instance to parse the incoming YAML data and create Java instances
public	Load(LoadSettings - configuration settings, BaseConstructor - custom YAML constructor constructor) Create instance to parse the incoming YAML data and create Java instances

Method Summary

Modifier and Type	Method and Description
private Composer	Returns: configured Composer createComposer(StreamReader - the input streamReader) Create Composer
protected Composer	Returns: configured Composer createComposer(InputStream - the input yamlStream) Create Composer
protected Composer	Returns: configured Composer createComposer(String - the input yaml) Create Composer
protected Composer	Returns: configured Composer createComposer(Reader - the input yamlReader) Create Composer
private Iterable<Object>	loadAll(Composer composer)
public Iterable<Object>	Returns: an Iterable over the parsed Java objects in this stream in proper sequence loadAllFromInputStream(InputStream - YAML data to load from (BOM is respected to detect encoding and removed from the data) yamlStream) Parse all YAML documents in a stream and produce corresponding Java objects.
public Iterable<Object>	Returns: an Iterable over the parsed Java objects in this stream in proper sequence loadAllFromReader(Reader - YAML data to load from (BOM must not be present) yamlReader) Parse all YAML documents in a String and produce corresponding Java objects.
public Iterable<Object>	Returns: an Iterable over the parsed Java objects in this stream in proper sequence loadAllFromString(String - YAML data to load from (BOM must not be present) yaml) Parse all YAML documents in a String and produce corresponding Java objects.
public Object	Returns: parsed Java instance loadFromInputStream(InputStream - data to load from (BOM is respected to detect encoding and removed from the data) yamlStream) Parse the only YAML document in a stream and produce the corresponding Java object.
public Object	Returns: parsed Java instance loadFromReader(Reader - data to load from (BOM must not be present) yamlReader) Parse a YAML document and create a Java instance
public Object	Returns: parsed Java instance loadFromString(String - YAML data to load from (BOM must not be present) yaml) Parse a YAML document and create a Java instance
protected Object	Returns: deserialised YAML document loadOne(Composer - the component to create the Node composer) Load with provided Composer

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

constructor	back to summary
private final BaseConstructor constructor

settings	back to summary
private final LoadSettings settings

Constructor Detail

Load	back to summary
public Load(LoadSettings settings) Create instance to parse the incoming YAML data and create Java instances Parameters settings:LoadSettings - configuration

Load

back to summary

public Load(LoadSettings settings)

Create instance to parse the incoming YAML data and create Java instances

Parameters

settings:LoadSettings: - configuration

Load	back to summary
public Load(LoadSettings settings, BaseConstructor constructor) Create instance to parse the incoming YAML data and create Java instances Parameters settings:LoadSettings - configuration constructor:BaseConstructor - custom YAML constructor

Load

back to summary

public Load(LoadSettings settings, BaseConstructor constructor)

Create instance to parse the incoming YAML data and create Java instances

Parameters

settings:LoadSettings: - configuration
constructor:BaseConstructor: - custom YAML constructor

Method Detail

createComposer	back to summary
private Composer createComposer(StreamReader streamReader) Create Composer Parameters streamReader:StreamReader - the input Returns:Composer configured Composer

createComposer

back to summary

private Composer createComposer(StreamReader streamReader)

Create Composer

Parameters

streamReader:StreamReader: - the input

Returns:Composer

configured Composer

createComposer	back to summary
protected Composer createComposer(InputStream yamlStream) Create Composer Parameters yamlStream:InputStream - the input Returns:Composer configured Composer

createComposer

back to summary

protected Composer createComposer(InputStream yamlStream)

Create Composer

Parameters

yamlStream:InputStream: - the input

Returns:Composer

configured Composer

createComposer	back to summary
protected Composer createComposer(String yaml) Create Composer Parameters yaml:String - the input Returns:Composer configured Composer

createComposer

back to summary

protected Composer createComposer(String yaml)

Create Composer

Parameters

yaml:String: - the input

Returns:Composer

configured Composer

createComposer	back to summary
protected Composer createComposer(Reader yamlReader) Create Composer Parameters yamlReader:Reader - the input Returns:Composer configured Composer

createComposer

back to summary

protected Composer createComposer(Reader yamlReader)

Create Composer

Parameters

yamlReader:Reader: - the input

Returns:Composer

configured Composer

loadAll	back to summary
private Iterable<Object> loadAll(Composer composer)

loadAllFromInputStream	back to summary
public Iterable<Object> loadAllFromInputStream(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:InputStream - YAML data to load from (BOM is respected to detect encoding and removed from the data) Returns:Iterable<Object> an Iterable over the parsed Java objects in this stream in proper sequence

loadAllFromInputStream

back to summary

public Iterable<Object> loadAllFromInputStream(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:InputStream: - YAML data to load from (BOM is respected to detect encoding and removed from the data)

Returns:Iterable<Object>

an Iterable over the parsed Java objects in this stream in proper sequence

loadAllFromReader	back to summary
public Iterable<Object> loadAllFromReader(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:Reader - YAML data to load from (BOM must not be present) Returns:Iterable<Object> an Iterable over the parsed Java objects in this stream in proper sequence

loadAllFromReader

back to summary

public Iterable<Object> loadAllFromReader(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:Reader: - YAML data to load from (BOM must not be present)

Returns:Iterable<Object>

an Iterable over the parsed Java objects in this stream in proper sequence

loadAllFromString	back to summary
public Iterable<Object> loadAllFromString(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:String - YAML data to load from (BOM must not be present) Returns:Iterable<Object> an Iterable over the parsed Java objects in this stream in proper sequence

loadAllFromString

back to summary

public Iterable<Object> loadAllFromString(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:String: - YAML data to load from (BOM must not be present)

Returns:Iterable<Object>

an Iterable over the parsed Java objects in this stream in proper sequence

loadFromInputStream	back to summary
public Object loadFromInputStream(InputStream yamlStream) Parse the only YAML document in a stream and produce the corresponding Java object. Parameters yamlStream:InputStream - data to load from (BOM is respected to detect encoding and removed from the data) Returns:Object parsed Java instance

loadFromInputStream

back to summary

public Object loadFromInputStream(InputStream yamlStream)

Parse the only YAML document in a stream and produce the corresponding Java object.

Parameters

yamlStream:InputStream: - data to load from (BOM is respected to detect encoding and removed from the data)

Returns:Object

parsed Java instance

loadFromReader	back to summary
public Object loadFromReader(Reader yamlReader) Parse a YAML document and create a Java instance Parameters yamlReader:Reader - data to load from (BOM must not be present) Returns:Object parsed Java instance

loadFromReader

back to summary

public Object loadFromReader(Reader yamlReader)

Parse a YAML document and create a Java instance

Parameters

yamlReader:Reader: - data to load from (BOM must not be present)

Returns:Object

parsed Java instance

loadFromString	back to summary
public Object loadFromString(String yaml) Parse a YAML document and create a Java instance Parameters yaml:String - YAML data to load from (BOM must not be present) Returns:Object parsed Java instance Exceptions YamlEngineException: if the YAML is not valid

loadFromString

back to summary

public Object loadFromString(String yaml)

Parse a YAML document and create a Java instance

Parameters

yaml:String: - YAML data to load from (BOM must not be present)

Returns:Object

parsed Java instance

Exceptions

YamlEngineException:: if the YAML is not valid

loadOne	back to summary
protected Object loadOne(Composer composer) Load with provided Composer Parameters composer:Composer - the component to create the Node Returns:Object deserialised YAML document

loadOne

back to summary

protected Object loadOne(Composer composer)

Load with provided Composer

Parameters

composer:Composer: - the component to create the Node

Returns:Object

deserialised YAML document

org.snakeyaml.engine.v2.api back to summary

private Class Load.YamlIterable

Class Inheritance

extends Object
implements Iterable<Object>

java.lang.Object
org.snakeyaml.engine.v2.api.Load.YamlIterable

All Implemented Interfaces

java.lang.Iterable

Field Summary

Modifier and Type	Field and Description
private final Iterator<Object>	iterator

Constructor Summary

Access	Constructor and Description
public	YamlIterable(Iterator<Object> iterator)

Method Summary

Modifier and Type	Method and Description
public Iterator<Object>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

iterator	back to summary
private final Iterator<Object> iterator

Constructor Detail

YamlIterable	back to summary
public YamlIterable(Iterator<Object> iterator)

Method Detail

iterator back to summary

iterator	back to summary
public Iterator<Object> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Annotations @Override

public Iterator<Object> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations

@Override

org.snakeyaml.engine.v2.api back to summary

private Class Load.YamlIterator

Class Inheritance

extends Object
implements Iterator<Object>

java.lang.Object
org.snakeyaml.engine.v2.api.Load.YamlIterator

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private final Composer	composer
private boolean	composerInitiated
private final BaseConstructor	constructor

Constructor Summary

Access	Constructor and Description
public	YamlIterator(Composer composer, BaseConstructor constructor)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Object	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

composer	back to summary
private final Composer composer

composerInitiated	back to summary
private boolean composerInitiated

constructor	back to summary
private final BaseConstructor constructor

Constructor Detail

YamlIterator	back to summary
public YamlIterator(Composer composer, BaseConstructor constructor)

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Annotations

@Override

next	back to summary
public Object next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Annotations @Override

back to summary

public Object next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public Class Load

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Load.YamlIterable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Load.YamlIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail