com.esotericsoftware.yamlbeans

Class YamlWriter

java.lang.Object

com.esotericsoftware.yamlbeans.YamlWriter

public class YamlWriter
extends Object

Serializes Java objects as YAML.

Author:

Nathan Sweet

Constructor Summary

Constructors

Constructor and Description
YamlWriter(Writer writer)
YamlWriter(Writer writer, YamlConfig config)

Method Summary

Modifier and Type	Method and Description
void	clearAnchors() Writes any buffered objects, then resets the list of anchored objects.
void	close() Finishes writing any buffered output and releases all resources.
YamlConfig	getConfig()
Emitter	getEmitter() Returns the YAML emitter, which allows the YAML output to be configured.
void	setAlias(Object object, String alias)
void	write(Object object)

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlWriter

public YamlWriter(Writer writer)

YamlWriter

public YamlWriter(Writer writer,
                  YamlConfig config)

Method Detail

setAlias

public void setAlias(Object object,
                     String alias)

write

public void write(Object object)
           throws YamlException

Throws:

YamlException

getConfig

public YamlConfig getConfig()

getEmitter

public Emitter getEmitter()

Returns the YAML emitter, which allows the YAML output to be configured.

clearAnchors

public void clearAnchors()
                  throws YamlException

Writes any buffered objects, then resets the list of anchored objects.

Throws:

YamlException

See Also:

YamlConfig.WriteConfig.setAutoAnchor(boolean)

close

public void close()
           throws YamlException

Finishes writing any buffered output and releases all resources.

Throws:

YamlException - If the buffered output could not be written or the writer could not be closed.