Package org.snakeyaml.engine.v2.api

Class Dump

java.lang.Object

org.snakeyaml.engine.v2.api.Dump

public class Dump
extends Object

Common way to serialize any Java instance(s) The instance is stateful. Only one of the 'dump' methods may be called and it may be called only once.

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseRepresenter	representer
protected DumpSettings	settings

Constructor Summary

Constructors

Constructor	Description
Dump(DumpSettings settings)	Create instance
Dump(DumpSettings settings, BaseRepresenter representer)	Create instance

Method Summary

Modifier and Type	Method	Description
void	dump(Object yaml, StreamDataWriter streamDataWriter)	Dump a single instance into a YAML document
void	dumpAll(Iterator<? extends Object> instancesIterator, StreamDataWriter streamDataWriter)	Dump all the instances from the iterator into a stream with every instance in a separate YAML document
String	dumpAllToString(Iterator<? extends Object> instancesIterator)	Dump all the instances from the iterator into a stream with every instance in a separate YAML document
void	dumpNode(Node node, StreamDataWriter streamDataWriter)	Dump the provided Node into a YAML stream.
String	dumpToString(Object yaml)	Dump all the instances from the iterator into a stream with every instance in a separate YAML document

Methods inherited from class java.lang.Object

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

Field Detail

settings

protected DumpSettings settings

representer

protected BaseRepresenter representer

Constructor Detail

Dump

public Dump(DumpSettings settings)

Create instance

Parameters:

settings - - configuration

Dump

public Dump(DumpSettings settings,
            BaseRepresenter representer)

Create instance

Parameters:

settings - - configuration

representer - - custom representer

Method Detail

dumpAll

public void dumpAll(Iterator<? extends Object> instancesIterator,
                    StreamDataWriter streamDataWriter)

Dump all the instances from the iterator into a stream with every instance in a separate YAML document

Parameters:

instancesIterator - - instances to serialize

streamDataWriter - - destination I/O writer

dump

public void dump(Object yaml,
                 StreamDataWriter streamDataWriter)

Dump a single instance into a YAML document

Parameters:

yaml - - instance to serialize

streamDataWriter - - destination I/O writer

dumpAllToString

public String dumpAllToString(Iterator<? extends Object> instancesIterator)

Dump all the instances from the iterator into a stream with every instance in a separate YAML document

Parameters:

instancesIterator - - instances to serialize

Returns:

String representation of the YAML stream

dumpToString

public String dumpToString(Object yaml)

Dump all the instances from the iterator into a stream with every instance in a separate YAML document

Parameters:

yaml - - instance to serialize

Returns:

String representation of the YAML stream

dumpNode

public void dumpNode(Node node,
                     StreamDataWriter streamDataWriter)

Dump the provided Node into a YAML stream.

Parameters:

node - - YAML node to be serialized to YAML

streamDataWriter - - stream to write to