Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Yaml.EventIterable
private static class	Yaml.NodeIterable
private static class	Yaml.SilentEmitter
private static class	Yaml.YamlIterable

Field Summary

Modifier and Type	Field and Description
protected BaseConstructor	constructor
protected DumperOptions	dumperOptions
protected LoaderOptions	loadingConfig
private String	name
protected Representer	representer
protected final Resolver	resolver

Constructor Summary

Access	Constructor and Description
public	Yaml() Create Yaml instance.
public	Yaml(DumperOptions DumperOptions to configure outgoing objects dumperOptions) Create Yaml instance.
public	Yaml(LoaderOptions LoadingConfig to control load behavior loadingConfig) Create Yaml instance.
public	Yaml(Representer Representer to emit outgoing objects representer) Create Yaml instance.
public	Yaml(BaseConstructor BaseConstructor to construct incoming documents constructor) Create Yaml instance.
public	Yaml(BaseConstructor BaseConstructor to construct incoming documents constructor, Representer Representer to emit outgoing objects representer) Create Yaml instance.
public	Yaml(Representer Representer to emit outgoing objects representer, DumperOptions DumperOptions to configure outgoing objects dumperOptions) Create Yaml instance.
public	Yaml(BaseConstructor BaseConstructor to construct incoming documents. Its LoaderOptions will be used everywhere constructor, Representer Representer to emit outgoing objects representer, DumperOptions DumperOptions to configure outgoing objects dumperOptions) Create Yaml instance.
public	Yaml(BaseConstructor BaseConstructor to construct incoming documents constructor, Representer Representer to emit outgoing objects representer, DumperOptions DumperOptions to configure outgoing objects dumperOptions, LoaderOptions LoadingConfig to control load behavior loadingConfig) Create Yaml instance.
public	Yaml(BaseConstructor BaseConstructor to construct incoming documents constructor, Representer Representer to emit outgoing objects representer, DumperOptions DumperOptions to configure outgoing objects dumperOptions, Resolver Resolver to detect implicit type resolver) Create Yaml instance.
public	Yaml(BaseConstructor BaseConstructor to construct incoming documents constructor, Representer Representer to emit outgoing objects representer, DumperOptions DumperOptions to configure outgoing objects dumperOptions, LoaderOptions LoadingConfig to control load behavior loadingConfig, Resolver Resolver to detect implicit type resolver) Create Yaml instance.

Method Summary

Modifier and Type	Method and Description
public void	addImplicitResolver(Tag tag to assign to the node tag, Pattern regular expression to match against regexp, String a sequence of possible initial characters or null (which means any). first) Add an implicit scalar detector.
public void	addImplicitResolver(Tag tag to assign to the node tag, Pattern regular expression to match against regexp, String a sequence of possible initial characters or null (which means any). first, int the max length of the value which may match the regular expression limit) Add an implicit scalar detector.
public void	addTypeDescription(TypeDescription td)
public Node	Returns: parsed root Node for the specified YAML document compose(Reader YAML document yaml) Parse the first YAML document in a stream and produce the corresponding representation tree.
public Iterable<Node>	Returns: parsed root Nodes for all the specified YAML documents composeAll(Reader stream of YAML documents yaml) Parse all YAML documents in a stream and produce corresponding representation trees.
public String	Returns: YAML String dump(Object Java object to be Serialized to YAML data) Serialize a Java object into a YAML String.
public void	dump(Object Java object to be serialized to YAML data, Writer stream to write to output) Serialize a Java object into a YAML stream.
public String	Returns: YAML String with all the objects in proper sequence dumpAll(Iterator<? extends Object> Iterator with Objects data) Serialize a sequence of Java objects into a YAML String.
public void	dumpAll(Iterator<? extends Object> Iterator with Objects data, Writer stream to write to output) Serialize a sequence of Java objects into a YAML stream.
private void	dumpAll(Iterator<? extends Object> data, Writer output, Tag rootTag)
public String	Returns: YAML String dumpAs(Object Java object to be serialized to YAML data, Tag the tag for the whole YAML document. The tag should be Tag.MAP for a JavaBean to make the tag disappear (to use implicit tag !!map). If `null` is provided then the standard tag with the full class name is used. rootTag, DumperOptions.FlowStyle flow style for the whole document. See Chapter 10. Collection Styles http://yaml.org/spec/1.1/#id930798. If `null` is provided then the flow style from DumperOptions is used. flowStyle) Serialize a Java object into a YAML string.
public String	Returns: YAML String dumpAsMap(Object Java object to be serialized to YAML data) Serialize a Java object into a YAML string.
public String	Returns: human readable name getName() Get a meaningful name.
private static DumperOptions	initDumperOptions(Representer representer)
public < the class of the instance to be created T> T	Returns: parsed object load(String YAML data to load from (BOM must not be present) yaml) Parse the only YAML document in a String and produce the corresponding Java object.
public < the class of the instance to be created T> T	Returns: parsed object load(InputStream data to load from (BOM is respected to detect encoding and removed from the data) io) Parse the only YAML document in a stream and produce the corresponding Java object.
public < the class of the instance to be created T> T	Returns: parsed object load(Reader data to load from (BOM must not be present) io) Parse the only YAML document in a stream and produce the corresponding Java object.
public Iterable<Object>	Returns: an Iterable over the parsed Java objects in this String in proper sequence loadAll(Reader YAML data to load from (BOM must not be present) yaml) Parse all YAML documents in the Reader and produce corresponding Java objects.
public Iterable<Object>	Returns: an Iterable over the parsed Java objects in this String in proper sequence loadAll(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 Iterable<Object>	Returns: an Iterable over the parsed Java objects in this stream in proper sequence loadAll(InputStream YAML data to load from (BOM is respected to detect encoding and removed from the data) yaml) Parse all YAML documents in a stream and produce corresponding Java objects.
public < Class is defined by the second argument T> T	Returns: parsed object loadAs(Reader data to load from (BOM must not be present) io, Class<? super T> Class of the object to be created type) Parse the only YAML document in a stream and produce the corresponding Java object.
public < Class is defined by the second argument T> T	Returns: parsed object loadAs(String YAML data to load from (BOM must not be present) yaml, Class<? super T> Class of the object to be created type) Parse the only YAML document in a String and produce the corresponding Java object.
public < Class is defined by the second argument T> T	Returns: parsed object loadAs(InputStream data to load from (BOM is respected to detect encoding and removed from the data) input, Class<? super T> Class of the object to be created type) Parse the only YAML document in a stream and produce the corresponding Java object.
private Object	loadFromReader(StreamReader sreader, Class<?> type)
public Iterable<Event>	Returns: parsed events parse(Reader YAML document(s) yaml) Parse a YAML stream and produce parsing events.
public Node	Returns: representation tree represent(Object instance to build the representation tree for data) Produce the corresponding representation tree for a given Object.
public void	serialize(Node YAML node to be serialized to YAML node, Writer stream to write to output) Serialize (dump) a YAML node into a YAML stream.
public List<Event>	Returns: Event list serialize(Node representation tree data) Serialize the representation tree into Events.
public void	setBeanAccess(BeanAccess beanAccess)
public void	setName(String human readable name name) Set a meaningful name to be shown in toString()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

constructor	back to summary
protected BaseConstructor constructor

dumperOptions	back to summary
protected DumperOptions dumperOptions

loadingConfig	back to summary
protected LoaderOptions loadingConfig

name	back to summary
private String name

representer	back to summary
protected Representer representer

resolver	back to summary
protected final Resolver resolver

Constructor Detail

Yaml	back to summary
public Yaml() Create Yaml instance.

Yaml	back to summary
public Yaml(DumperOptions dumperOptions) Create Yaml instance. Parameters dumperOptions:DumperOptions DumperOptions to configure outgoing objects

Yaml

back to summary

public Yaml(DumperOptions dumperOptions)

Create Yaml instance.

Parameters

dumperOptions:DumperOptions: DumperOptions to configure outgoing objects

Yaml	back to summary
public Yaml(LoaderOptions loadingConfig) Create Yaml instance. Parameters loadingConfig:LoaderOptions LoadingConfig to control load behavior

Yaml

back to summary

public Yaml(LoaderOptions loadingConfig)

Create Yaml instance.

Parameters

loadingConfig:LoaderOptions: LoadingConfig to control load behavior

Yaml	back to summary
public Yaml(Representer representer) Create Yaml instance. Parameters representer:Representer Representer to emit outgoing objects

Yaml

back to summary

public Yaml(Representer representer)

Create Yaml instance.

Parameters

representer:Representer: Representer to emit outgoing objects

Yaml	back to summary
public Yaml(BaseConstructor constructor) Create Yaml instance. Parameters constructor:BaseConstructor BaseConstructor to construct incoming documents

Yaml

back to summary

public Yaml(BaseConstructor constructor)

Create Yaml instance.

Parameters

constructor:BaseConstructor: BaseConstructor to construct incoming documents

Yaml	back to summary
public Yaml(BaseConstructor constructor, Representer representer) Create Yaml instance. Parameters constructor:BaseConstructor BaseConstructor to construct incoming documents representer:Representer Representer to emit outgoing objects

Yaml

back to summary

public Yaml(BaseConstructor constructor, Representer representer)

Create Yaml instance.

Parameters

constructor:BaseConstructor: BaseConstructor to construct incoming documents
representer:Representer: Representer to emit outgoing objects

Yaml	back to summary
public Yaml(Representer representer, DumperOptions dumperOptions) Create Yaml instance. It is safe to create a few instances and use them in different Threads. Parameters representer:Representer Representer to emit outgoing objects dumperOptions:DumperOptions DumperOptions to configure outgoing objects

Yaml

back to summary

public Yaml(Representer representer, DumperOptions dumperOptions)

Create Yaml instance. It is safe to create a few instances and use them in different Threads.

Parameters

representer:Representer: Representer to emit outgoing objects
dumperOptions:DumperOptions: DumperOptions to configure outgoing objects

Yaml	back to summary
public Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions) Create Yaml instance. It is safe to create a few instances and use them in different Threads. Parameters constructor:BaseConstructor BaseConstructor to construct incoming documents. Its LoaderOptions will be used everywhere representer:Representer Representer to emit outgoing objects dumperOptions:DumperOptions DumperOptions to configure outgoing objects

Yaml

back to summary

public Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions)

Create Yaml instance. It is safe to create a few instances and use them in different Threads.

Parameters

constructor:BaseConstructor: BaseConstructor to construct incoming documents. Its LoaderOptions will be used everywhere
representer:Representer: Representer to emit outgoing objects
dumperOptions:DumperOptions: DumperOptions to configure outgoing objects

Yaml	back to summary
public Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions, LoaderOptions loadingConfig) Create Yaml instance. It is safe to create a few instances and use them in different Threads. Parameters constructor:BaseConstructor BaseConstructor to construct incoming documents representer:Representer Representer to emit outgoing objects dumperOptions:DumperOptions DumperOptions to configure outgoing objects loadingConfig:LoaderOptions LoadingConfig to control load behavior

Yaml

back to summary

public Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions, LoaderOptions loadingConfig)

Create Yaml instance. It is safe to create a few instances and use them in different Threads.

Parameters

constructor:BaseConstructor: BaseConstructor to construct incoming documents
representer:Representer: Representer to emit outgoing objects
dumperOptions:DumperOptions: DumperOptions to configure outgoing objects
loadingConfig:LoaderOptions: LoadingConfig to control load behavior

Yaml	back to summary
public Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions, Resolver resolver) Create Yaml instance. It is safe to create a few instances and use them in different Threads. Parameters constructor:BaseConstructor BaseConstructor to construct incoming documents representer:Representer Representer to emit outgoing objects dumperOptions:DumperOptions DumperOptions to configure outgoing objects resolver:Resolver Resolver to detect implicit type

Yaml

back to summary

public Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions, Resolver resolver)

Create Yaml instance. It is safe to create a few instances and use them in different Threads.

Parameters

constructor:BaseConstructor: BaseConstructor to construct incoming documents
representer:Representer: Representer to emit outgoing objects
dumperOptions:DumperOptions: DumperOptions to configure outgoing objects
resolver:Resolver: Resolver to detect implicit type

Yaml	back to summary
public Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions, LoaderOptions loadingConfig, Resolver resolver) Create Yaml instance. It is safe to create a few instances and use them in different Threads. Parameters constructor:BaseConstructor BaseConstructor to construct incoming documents representer:Representer Representer to emit outgoing objects dumperOptions:DumperOptions DumperOptions to configure outgoing objects loadingConfig:LoaderOptions LoadingConfig to control load behavior resolver:Resolver Resolver to detect implicit type

Yaml

back to summary

public Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions, LoaderOptions loadingConfig, Resolver resolver)

Create Yaml instance. It is safe to create a few instances and use them in different Threads.

Parameters

constructor:BaseConstructor: BaseConstructor to construct incoming documents
representer:Representer: Representer to emit outgoing objects
dumperOptions:DumperOptions: DumperOptions to configure outgoing objects
loadingConfig:LoaderOptions: LoadingConfig to control load behavior
resolver:Resolver: Resolver to detect implicit type

Method Detail

addImplicitResolver	back to summary
public void addImplicitResolver(Tag tag, Pattern regexp, String first) Add an implicit scalar detector. If an implicit scalar value matches the given regexp, the corresponding tag is assigned to the scalar. Parameters tag:Tag tag to assign to the node regexp:Pattern regular expression to match against first:String a sequence of possible initial characters or null (which means any).

addImplicitResolver

back to summary

public void addImplicitResolver(Tag tag, Pattern regexp, String first)

Add an implicit scalar detector. If an implicit scalar value matches the given regexp, the corresponding tag is assigned to the scalar.

Parameters

tag:Tag: tag to assign to the node
regexp:Pattern: regular expression to match against
first:String: a sequence of possible initial characters or null (which means any).

addImplicitResolver	back to summary
public void addImplicitResolver(Tag tag, Pattern regexp, String first, int limit) Add an implicit scalar detector. If an implicit scalar value matches the given regexp, the corresponding tag is assigned to the scalar. Parameters tag:Tag tag to assign to the node regexp:Pattern regular expression to match against first:String a sequence of possible initial characters or null (which means any). limit:int the max length of the value which may match the regular expression

addImplicitResolver

back to summary

public void addImplicitResolver(Tag tag, Pattern regexp, String first, int limit)

Add an implicit scalar detector. If an implicit scalar value matches the given regexp, the corresponding tag is assigned to the scalar.

Parameters

tag:Tag: tag to assign to the node
regexp:Pattern: regular expression to match against
first:String: a sequence of possible initial characters or null (which means any).
limit:int: the max length of the value which may match the regular expression

addTypeDescription	back to summary
public void addTypeDescription(TypeDescription td)

compose	back to summary
public Node compose(Reader yaml) Parse the first YAML document in a stream and produce the corresponding representation tree. (This is the opposite of the represent() method) Parameters yaml:Reader YAML document Returns:Node parsed root Node for the specified YAML document See Also Figure 3.1. Processing Overview

compose

back to summary

public Node compose(Reader yaml)

Parse the first YAML document in a stream and produce the corresponding representation tree. (This is the opposite of the represent() method)

Parameters

yaml:Reader: YAML document

Returns:Node

parsed root Node for the specified YAML document

See Also

Figure 3.1. Processing Overview

composeAll	back to summary
public Iterable<Node> composeAll(Reader yaml) Parse all YAML documents in a stream and produce corresponding representation trees. Parameters yaml:Reader stream of YAML documents Returns:Iterable<Node> parsed root Nodes for all the specified YAML documents See Also Processing Overview

composeAll

back to summary

public Iterable<Node> composeAll(Reader yaml)

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

Parameters

yaml:Reader: stream of YAML documents

Returns:Iterable<Node>

parsed root Nodes for all the specified YAML documents

See Also

Processing Overview

dump	back to summary
public String dump(Object data) Serialize a Java object into a YAML String. Parameters data:Object Java object to be Serialized to YAML Returns:String YAML String

dump

back to summary

public String dump(Object data)

Serialize a Java object into a YAML String.

Parameters

data:Object: Java object to be Serialized to YAML

Returns:String

YAML String

dump	back to summary
public void dump(Object data, Writer output) Serialize a Java object into a YAML stream. Parameters data:Object Java object to be serialized to YAML output:Writer stream to write to

dump

back to summary

public void dump(Object data, Writer output)

Serialize a Java object into a YAML stream.

Parameters

data:Object: Java object to be serialized to YAML
output:Writer: stream to write to

dumpAll	back to summary
public String dumpAll(Iterator<? extends Object> data) Serialize a sequence of Java objects into a YAML String. Parameters data:Iterator<? extends Object> Iterator with Objects Returns:String YAML String with all the objects in proper sequence

dumpAll

back to summary

public String dumpAll(Iterator<? extends Object> data)

Serialize a sequence of Java objects into a YAML String.

Parameters

data:Iterator<? extends Object>: Iterator with Objects

Returns:String

YAML String with all the objects in proper sequence

dumpAll	back to summary
public void dumpAll(Iterator<? extends Object> data, Writer output) Serialize a sequence of Java objects into a YAML stream. Parameters data:Iterator<? extends Object> Iterator with Objects output:Writer stream to write to

dumpAll

back to summary

public void dumpAll(Iterator<? extends Object> data, Writer output)

Serialize a sequence of Java objects into a YAML stream.

Parameters

data:Iterator<? extends Object>: Iterator with Objects
output:Writer: stream to write to

dumpAll	back to summary
private void dumpAll(Iterator<? extends Object> data, Writer output, Tag rootTag)

dumpAs back to summary

dumpAs	back to summary
public String dumpAs(Object data, Tag rootTag, DumperOptions.FlowStyle flowStyle) Serialize a Java object into a YAML string. Override the default root tag with `rootTag`. This method is similar to `Yaml.dump(data)` except that the root tag for the whole document is replaced with the given tag. This has two main uses. First, if the root tag is replaced with a standard YAML tag, such as `Tag.MAP`, then the object will be dumped as a map. The root tag will appear as `!!map`, or blank (implicit !!map). Second, if the root tag is replaced by a different custom tag, then the document appears to be a different type when loaded. For example, if an instance of MyClass is dumped with the tag !!YourClass, then it will be handled as an instance of YourClass when loaded. Parameters data:Object Java object to be serialized to YAML rootTag:Tag the tag for the whole YAML document. The tag should be Tag.MAP for a JavaBean to make the tag disappear (to use implicit tag !!map). If `null` is provided then the standard tag with the full class name is used. flowStyle:DumperOptions.FlowStyle flow style for the whole document. See Chapter 10. Collection Styles http://yaml.org/spec/1.1/#id930798. If `null` is provided then the flow style from DumperOptions is used. Returns:String YAML String

public String dumpAs(Object data, Tag rootTag, DumperOptions.FlowStyle flowStyle)

Serialize a Java object into a YAML string. Override the default root tag with rootTag.

This method is similar to Yaml.dump(data) except that the root tag for the whole document is replaced with the given tag. This has two main uses.

First, if the root tag is replaced with a standard YAML tag, such as Tag.MAP, then the object will be dumped as a map. The root tag will appear as !!map, or blank (implicit !!map).

Second, if the root tag is replaced by a different custom tag, then the document appears to be a different type when loaded. For example, if an instance of MyClass is dumped with the tag !!YourClass, then it will be handled as an instance of YourClass when loaded.

Parameters

data:Object: Java object to be serialized to YAML
rootTag:Tag: the tag for the whole YAML document. The tag should be Tag.MAP for a JavaBean to make the tag disappear (to use implicit tag !!map). If null is provided then the standard tag with the full class name is used.
flowStyle:DumperOptions.FlowStyle: flow style for the whole document. See Chapter 10. Collection Styles http://yaml.org/spec/1.1/#id930798. If null is provided then the flow style from DumperOptions is used.

Returns:String

YAML String

dumpAsMap back to summary

dumpAsMap	back to summary
public String dumpAsMap(Object data) Serialize a Java object into a YAML string. Override the default root tag with `Tag.MAP`. This method is similar to `Yaml.dump(data)` except that the root tag for the whole document is replaced with `Tag.MAP` tag (implicit !!map). Block Mapping is used as the collection style. See 10.2.2. Block Mappings (http://yaml.org/spec/1.1/#id934537) Parameters data:Object Java object to be serialized to YAML Returns:String YAML String

public String dumpAsMap(Object data)

Serialize a Java object into a YAML string. Override the default root tag with Tag.MAP.

This method is similar to Yaml.dump(data) except that the root tag for the whole document is replaced with Tag.MAP tag (implicit !!map).

Block Mapping is used as the collection style. See 10.2.2. Block Mappings (http://yaml.org/spec/1.1/#id934537)

Parameters

data:Object: Java object to be serialized to YAML

Returns:String

YAML String

getName	back to summary
public String getName() Get a meaningful name. It simplifies debugging in a multi-threaded environment. If nothing is set explicitly the address of the instance is returned. Returns:String human readable name

getName

back to summary

public String getName()

Get a meaningful name. It simplifies debugging in a multi-threaded environment. If nothing is set explicitly the address of the instance is returned.

Returns:String: human readable name

initDumperOptions	back to summary
private static DumperOptions initDumperOptions(Representer representer)

load	back to summary
public <T> T load(String yaml) Parse the only YAML document in a String and produce the corresponding Java object. (Because the encoding in known BOM is not respected.) Parameters <T> the class of the instance to be created yaml:String YAML data to load from (BOM must not be present) Returns:T parsed object Annotations @SuppressWarnings:unchecked

load

back to summary

public <T> T load(String yaml)

Parse the only YAML document in a String and produce the corresponding Java object. (Because the encoding in known BOM is not respected.)

Parameters

<T>: the class of the instance to be created
yaml:String: YAML data to load from (BOM must not be present)

Returns:T

parsed object

Annotations

@SuppressWarnings:unchecked

load	back to summary
public <T> T load(InputStream io) Parse the only YAML document in a stream and produce the corresponding Java object. Parameters <T> the class of the instance to be created io:InputStream data to load from (BOM is respected to detect encoding and removed from the data) Returns:T parsed object Annotations @SuppressWarnings:unchecked

load

back to summary

public <T> T load(InputStream io)

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

Parameters

<T>: the class of the instance to be created
io:InputStream: data to load from (BOM is respected to detect encoding and removed from the data)

Returns:T

parsed object

Annotations

@SuppressWarnings:unchecked

load	back to summary
public <T> T load(Reader io) Parse the only YAML document in a stream and produce the corresponding Java object. Parameters <T> the class of the instance to be created io:Reader data to load from (BOM must not be present) Returns:T parsed object Annotations @SuppressWarnings:unchecked

load

back to summary

public <T> T load(Reader io)

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

Parameters

<T>: the class of the instance to be created
io:Reader: data to load from (BOM must not be present)

Returns:T

parsed object

Annotations

@SuppressWarnings:unchecked

loadAll	back to summary
public Iterable<Object> loadAll(Reader yaml) Parse all YAML documents in the Reader and produce corresponding Java objects. The documents are parsed only when the iterator is invoked. Parameters yaml:Reader YAML data to load from (BOM must not be present) Returns:Iterable<Object> an Iterable over the parsed Java objects in this String in proper sequence

loadAll

back to summary

public Iterable<Object> loadAll(Reader yaml)

Parse all YAML documents in the Reader and produce corresponding Java objects. The documents are parsed only when the iterator is invoked.

Parameters

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

Returns:Iterable<Object>

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

loadAll	back to summary
public Iterable<Object> loadAll(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 String in proper sequence

loadAll

back to summary

public Iterable<Object> loadAll(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 String in proper sequence

loadAll	back to summary
public Iterable<Object> loadAll(InputStream yaml) Parse all YAML documents in a stream and produce corresponding Java objects. The documents are parsed only when the iterator is invoked. Parameters yaml: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

loadAll

back to summary

public Iterable<Object> loadAll(InputStream yaml)

Parse all YAML documents in a stream and produce corresponding Java objects. The documents are parsed only when the iterator is invoked.

Parameters

yaml: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

loadAs	back to summary
public <T> T loadAs(Reader io, Class<? super T> type) Parse the only YAML document in a stream and produce the corresponding Java object. Parameters <T> Class is defined by the second argument io:Reader data to load from (BOM must not be present) type:Class<? super T> Class of the object to be created Returns:T parsed object Annotations @SuppressWarnings:unchecked

loadAs

back to summary

public <T> T loadAs(Reader io, Class<? super T> type)

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

Parameters

<T>: Class is defined by the second argument
io:Reader: data to load from (BOM must not be present)
type:Class<? super T>: Class of the object to be created

Returns:T

parsed object

Annotations

@SuppressWarnings:unchecked

loadAs	back to summary
public <T> T loadAs(String yaml, Class<? super T> type) Parse the only YAML document in a String and produce the corresponding Java object. (Because the encoding in known BOM is not respected.) Parameters <T> Class is defined by the second argument yaml:String YAML data to load from (BOM must not be present) type:Class<? super T> Class of the object to be created Returns:T parsed object Annotations @SuppressWarnings:unchecked

loadAs

back to summary

public <T> T loadAs(String yaml, Class<? super T> type)

Parse the only YAML document in a String and produce the corresponding Java object. (Because the encoding in known BOM is not respected.)

Parameters

<T>: Class is defined by the second argument
yaml:String: YAML data to load from (BOM must not be present)
type:Class<? super T>: Class of the object to be created

Returns:T

parsed object

Annotations

@SuppressWarnings:unchecked

loadAs	back to summary
public <T> T loadAs(InputStream input, Class<? super T> type) Parse the only YAML document in a stream and produce the corresponding Java object. Parameters <T> Class is defined by the second argument input:InputStream data to load from (BOM is respected to detect encoding and removed from the data) type:Class<? super T> Class of the object to be created Returns:T parsed object Annotations @SuppressWarnings:unchecked

loadAs

back to summary

public <T> T loadAs(InputStream input, Class<? super T> type)

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

Parameters

<T>: Class is defined by the second argument
input:InputStream: data to load from (BOM is respected to detect encoding and removed from the data)
type:Class<? super T>: Class of the object to be created

Returns:T

parsed object

Annotations

@SuppressWarnings:unchecked

loadFromReader	back to summary
private Object loadFromReader(StreamReader sreader, Class<?> type)

parse	back to summary
public Iterable<Event> parse(Reader yaml) Parse a YAML stream and produce parsing events. Parameters yaml:Reader YAML document(s) Returns:Iterable<Event> parsed events See Also Processing Overview

parse

back to summary

public Iterable<Event> parse(Reader yaml)

Parse a YAML stream and produce parsing events.

Parameters

yaml:Reader: YAML document(s)

Returns:Iterable<Event>

parsed events

See Also

Processing Overview

represent	back to summary
public Node represent(Object data) Produce the corresponding representation tree for a given Object. Parameters data:Object instance to build the representation tree for Returns:Node representation tree See Also Figure 3.1. Processing Overview

represent

back to summary

public Node represent(Object data)

Produce the corresponding representation tree for a given Object.

Parameters

data:Object: instance to build the representation tree for

Returns:Node

representation tree

See Also

Figure 3.1. Processing Overview

serialize	back to summary
public void serialize(Node node, Writer output) Serialize (dump) a YAML node into a YAML stream. Parameters node:Node YAML node to be serialized to YAML output:Writer stream to write to

serialize

back to summary

public void serialize(Node node, Writer output)

Serialize (dump) a YAML node into a YAML stream.

Parameters

node:Node: YAML node to be serialized to YAML
output:Writer: stream to write to

serialize	back to summary
public List<Event> serialize(Node data) Serialize the representation tree into Events. Parameters data:Node representation tree Returns:List<Event> Event list See Also Processing Overview

serialize

back to summary

public List<Event> serialize(Node data)

Serialize the representation tree into Events.

Parameters