|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.yaml.snakeyaml.Yaml
public class Yaml
Public YAML interface. Each Thread must have its own instance.
Field Summary | |
---|---|
protected BaseConstructor |
constructor
|
protected DumperOptions |
dumperOptions
|
protected LoaderOptions |
loaderOptions
|
protected Representer |
representer
|
protected Resolver |
resolver
|
Constructor Summary | |
---|---|
Yaml()
Create Yaml instance. |
|
Yaml(BaseConstructor constructor)
Create Yaml instance. |
|
Yaml(BaseConstructor constructor,
LoaderOptions loaderOptions,
Representer representer,
DumperOptions dumperOptions,
Resolver resolver)
Create Yaml instance. |
|
Yaml(BaseConstructor constructor,
Representer representer)
Create Yaml instance. |
|
Yaml(BaseConstructor constructor,
Representer representer,
DumperOptions dumperOptions)
Create Yaml instance. |
|
Yaml(BaseConstructor constructor,
Representer representer,
DumperOptions dumperOptions,
Resolver resolver)
Create Yaml instance. |
|
Yaml(Dumper dumper)
Create Yaml instance. |
|
Yaml(DumperOptions dumperOptions)
Create Yaml instance. |
|
Yaml(Loader loader)
Deprecated. use with Constructor instead of Loader |
|
Yaml(Loader loader,
Dumper dumper)
Deprecated. use with Constructor instead of Loader |
|
Yaml(Loader loader,
Dumper dumper,
Resolver resolver)
Deprecated. use with Constructor instead of Loader |
|
Yaml(LoaderOptions loaderOptions)
|
|
Yaml(Representer representer)
Create Yaml instance. |
|
Yaml(Representer representer,
DumperOptions dumperOptions)
Create Yaml instance. |
Method Summary | ||
---|---|---|
void |
addImplicitResolver(String tag,
Pattern regexp,
String first)
Deprecated. use Tag instead of String |
|
void |
addImplicitResolver(Tag tag,
Pattern regexp,
String first)
Add an implicit scalar detector. |
|
Node |
compose(Reader yaml)
Parse the first YAML document in a stream and produce the corresponding representation tree. |
|
Iterable<Node> |
composeAll(Reader yaml)
Parse all YAML documents in a stream and produce corresponding representation trees. |
|
String |
dump(Object data)
Serialize a Java object into a YAML String. |
|
void |
dump(Object data,
Writer output)
Serialize a Java object into a YAML stream. |
|
String |
dumpAll(Iterator<? extends Object> data)
Serialize a sequence of Java objects into a YAML String. |
|
void |
dumpAll(Iterator<? extends Object> data,
Writer output)
Serialize a sequence of Java objects into a YAML stream. |
|
String |
dumpAs(Object data,
Tag rootTag,
DumperOptions.FlowStyle flowStyle)
Serialize a Java object into a YAML string. |
|
String |
dumpAsMap(Object data)
Serialize a Java object into a YAML string. |
|
String |
getName()
Get a meaningful name. |
|
Object |
load(InputStream io)
Parse the only YAML document in a stream and produce the corresponding Java object. |
|
Object |
load(Reader io)
Parse the only YAML document in a stream and produce the corresponding Java object. |
|
Object |
load(String yaml)
Parse the only YAML document in a String and produce the corresponding Java object. |
|
Iterable<Object> |
loadAll(InputStream yaml)
Parse all YAML documents in a stream and produce corresponding Java objects. |
|
Iterable<Object> |
loadAll(Reader yaml)
Parse all YAML documents in a String and produce corresponding Java objects. |
|
Iterable<Object> |
loadAll(String yaml)
Parse all YAML documents in a String and produce corresponding Java objects. |
|
|
loadAs(InputStream input,
Class<T> type)
Parse the only YAML document in a stream and produce the corresponding Java object. |
|
|
loadAs(Reader io,
Class<T> type)
Parse the only YAML document in a stream and produce the corresponding Java object. |
|
|
loadAs(String yaml,
Class<T> type)
Parse the only YAML document in a String and produce the corresponding Java object. |
|
Iterable<Event> |
parse(Reader yaml)
Parse a YAML stream and produce parsing events. |
|
Node |
represent(Object data)
Produce the corresponding representation tree for a given Object. |
|
List<Event> |
serialize(Node data)
Serialize the representation tree into Events. |
|
void |
setBeanAccess(BeanAccess beanAccess)
|
|
void |
setName(String name)
Set a meaningful name to be shown in toString() |
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final Resolver resolver
protected BaseConstructor constructor
protected Representer representer
protected DumperOptions dumperOptions
protected LoaderOptions loaderOptions
Constructor Detail |
---|
public Yaml()
public Yaml(LoaderOptions loaderOptions)
public Yaml(DumperOptions dumperOptions)
dumperOptions
- DumperOptions to configure outgoing objectspublic Yaml(Representer representer)
representer
- Representer to emit outgoing objectspublic Yaml(BaseConstructor constructor)
constructor
- BaseConstructor to construct incoming documentspublic Yaml(BaseConstructor constructor, Representer representer)
constructor
- BaseConstructor to construct incoming documentsrepresenter
- Representer to emit outgoing objectspublic Yaml(Representer representer, DumperOptions dumperOptions)
representer
- Representer to emit outgoing objectsdumperOptions
- DumperOptions to configure outgoing objectspublic Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions)
constructor
- BaseConstructor to construct incoming documentsrepresenter
- Representer to emit outgoing objectsdumperOptions
- DumperOptions to configure outgoing objectspublic Yaml(BaseConstructor constructor, Representer representer, DumperOptions dumperOptions, Resolver resolver)
constructor
- BaseConstructor to construct incoming documentsrepresenter
- Representer to emit outgoing objectsdumperOptions
- DumperOptions to configure outgoing objectsresolver
- Resolver to detect implicit typepublic Yaml(BaseConstructor constructor, LoaderOptions loaderOptions, Representer representer, DumperOptions dumperOptions, Resolver resolver)
constructor
- BaseConstructor to construct incoming documentsloaderOptions
- LoaderOptions to control construction processrepresenter
- Representer to emit outgoing objectsdumperOptions
- DumperOptions to configure outgoing objectsresolver
- Resolver to detect implicit typepublic Yaml(Loader loader)
public Yaml(Loader loader, Dumper dumper)
public Yaml(Loader loader, Dumper dumper, Resolver resolver)
public Yaml(Dumper dumper)
dumper
- Dumper to emit outgoing objectsMethod Detail |
---|
public String dump(Object data)
data
- Java object to be Serialized to YAML
public Node represent(Object data)
data
- instance to build the representation tree for
http://yaml.org/spec/1.1/#id859333
public String dumpAll(Iterator<? extends Object> data)
data
- Iterator with Objects
public void dump(Object data, Writer output)
data
- Java object to be serialized to YAMLoutput
- stream to write topublic void dumpAll(Iterator<? extends Object> data, Writer output)
data
- Iterator with Objectsoutput
- stream to write topublic 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.
data
- Java object to be serialized to YAMLrootTag
- 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
- 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.
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)
data
- Java object to be serialized to YAML
public List<Event> serialize(Node data)
data
- representation tree
http://yaml.org/spec/1.1/#id859333
public Object load(String yaml)
yaml
- YAML data to load from (BOM must not be present)
public Object load(InputStream io)
io
- data to load from (BOM is respected and removed)
public Object load(Reader io)
io
- data to load from (BOM must not be present)
public <T> T loadAs(Reader io, Class<T> type)
T
- Class is defined by the second argumentio
- data to load from (BOM must not be present)type
- Class of the object to be created
public <T> T loadAs(String yaml, Class<T> type)
T
- Class is defined by the second argumentyaml
- YAML data to load from (BOM must not be present)type
- Class of the object to be created
public <T> T loadAs(InputStream input, Class<T> type)
T
- Class is defined by the second argumentinput
- data to load from (BOM is respected and removed)type
- Class of the object to be created
public Iterable<Object> loadAll(Reader yaml)
yaml
- YAML data to load from (BOM must not be present)
public Iterable<Object> loadAll(String yaml)
yaml
- YAML data to load from (BOM must not be present)
public Iterable<Object> loadAll(InputStream yaml)
yaml
- YAML data to load from (BOM is respected and ignored)
public Node compose(Reader yaml)
yaml
- YAML document
http://yaml.org/spec/1.1/#id859333
public Iterable<Node> composeAll(Reader yaml)
yaml
- stream of YAML documents
http://yaml.org/spec/1.1/#id859333
public void addImplicitResolver(String tag, Pattern regexp, String first)
tag
- tag to assign to the noderegexp
- regular expression to match againstfirst
- a sequence of possible initial characters or null (which means
any).public void addImplicitResolver(Tag tag, Pattern regexp, String first)
tag
- tag to assign to the noderegexp
- regular expression to match againstfirst
- a sequence of possible initial characters or null (which means
any).public String toString()
toString
in class Object
public String getName()
public void setName(String name)
name
- human readable namepublic Iterable<Event> parse(Reader yaml)
yaml
- YAML document(s)
http://yaml.org/spec/1.1/#id859333
public void setBeanAccess(BeanAccess beanAccess)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |