com.esotericsoftware.yamlbeans

Class YamlReader

java.lang.Object

com.esotericsoftware.yamlbeans.YamlReader

public class YamlReader
extends Object

Deserializes Java objects from YAML.

Author:

Nathan Sweet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	YamlReader.YamlReaderException

Constructor Summary

Constructors

Constructor and Description
YamlReader(Reader reader)
YamlReader(Reader reader, YamlConfig config)
YamlReader(String yaml)
YamlReader(String yaml, YamlConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected Object	createObject(Class type) Returns a new object of the requested type.
YamlConfig	getConfig()
static void	main(String[] args)
Object	read() Reads the next YAML document and deserializes it into an object.
<T> T	read(Class<T> type) Reads an object of the specified type from YAML.
<T> T	read(Class<T> type, Class elementType) Reads an array, Map, List, or Collection object of the specified type from YAML, using the specified element type.
protected Object	readValue(Class type, Class elementType, Class defaultType) Reads an object from the YAML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YamlReader

public YamlReader(Reader reader)

YamlReader

public YamlReader(Reader reader,
          YamlConfig config)

YamlReader

public YamlReader(String yaml)

YamlReader

public YamlReader(String yaml,
          YamlConfig config)

Method Detail

getConfig

public YamlConfig getConfig()

close

public void close()
           throws IOException

Throws:

IOException

read

public Object read()
            throws YamlException

Reads the next YAML document and deserializes it into an object. The type of object is defined by the YAML tag. If there is no YAML tag, the object will be an ArrayList, HashMap, or String.

Throws:

YamlException

read

public <T> T read(Class<T> type)
       throws YamlException

Reads an object of the specified type from YAML.

Parameters:

type - The type of object to read. If null, behaves the same as {read().

Throws:

YamlException

read

public <T> T read(Class<T> type,
         Class elementType)
       throws YamlException

Reads an array, Map, List, or Collection object of the specified type from YAML, using the specified element type.

Parameters:

type - The type of object to read. If null, behaves the same as {read().

Throws:

YamlException

readValue

protected Object readValue(Class type,
               Class elementType,
               Class defaultType)
                    throws YamlException,
                           Parser.ParserException,
                           Tokenizer.TokenizerException

Reads an object from the YAML. Can be overidden to take some action for any of the objects returned.

Throws:

YamlException

Parser.ParserException

Tokenizer.TokenizerException

createObject

protected Object createObject(Class type)
                       throws InvocationTargetException

Returns a new object of the requested type.

Throws:

InvocationTargetException

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception