org.opendaylight.yangtools.yang.data.api.schema.stream

Class NormalizedNodeWriter

java.lang.Object

org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

SchemaOrderedNormalizedNodeWriter

@Beta
public class NormalizedNodeWriter
extends Object
implements Closeable, Flushable

This is an experimental iterator over a NormalizedNode. This is essentially the opposite of a XMLStreamReader -- unlike instantiating an iterator over the backing data, this encapsulates a NormalizedNodeStreamWriter and allows us to write multiple nodes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NormalizedNodeWriter(NormalizedNodeStreamWriter writer)

Method Summary

Modifier and Type	Method and Description
protected static int	childSizeHint(Iterable<?> children) Emit a best guess of a hint for a particular set of children.
void	close()
void	flush()
static NormalizedNodeWriter	forStreamWriter(NormalizedNodeStreamWriter writer) Create a new writer backed by a NormalizedNodeStreamWriter.
static NormalizedNodeWriter	forStreamWriter(NormalizedNodeStreamWriter writer, boolean orderKeyLeaves) Create a new writer backed by a NormalizedNodeStreamWriter.
protected NormalizedNodeStreamWriter	getWriter()
protected boolean	wasProcessAsSimpleNode(NormalizedNode<?,?> node)
protected boolean	wasProcessedAsCompositeNode(NormalizedNode<?,?> node)
NormalizedNodeWriter	write(NormalizedNode<?,?> node) Iterate over the provided NormalizedNode and emit write events to the encapsulated NormalizedNodeStreamWriter.
protected boolean	writeChildren(Iterable<? extends NormalizedNode<?,?>> children) Emit events for all children and then emit an endNode() event.
protected boolean	writeMapEntryNode(MapEntryNode node)

Methods inherited from class java.lang.Object

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

Constructor Detail

NormalizedNodeWriter

protected NormalizedNodeWriter(NormalizedNodeStreamWriter writer)

Method Detail

getWriter

protected final NormalizedNodeStreamWriter getWriter()

forStreamWriter

public static NormalizedNodeWriter forStreamWriter(NormalizedNodeStreamWriter writer)

Create a new writer backed by a NormalizedNodeStreamWriter.

Parameters:

writer - Back-end writer

Returns:

A new instance.

forStreamWriter

public static NormalizedNodeWriter forStreamWriter(NormalizedNodeStreamWriter writer,
                                                   boolean orderKeyLeaves)

Create a new writer backed by a NormalizedNodeStreamWriter. Unlike the simple forStreamWriter(NormalizedNodeStreamWriter) method, this allows the caller to switch off RFC6020 XML compliance, providing better throughput. The reason is that the XML mapping rules in RFC6020 require the encoding to emit leaf nodes which participate in a list's key first and in the order in which they are defined in the key. For JSON, this requirement is completely relaxed and leaves can be ordered in any way we see fit. The former requires a bit of work: first a lookup for each key and then for each emitted node we need to check whether it was already emitted.

Parameters:

writer - Back-end writer

orderKeyLeaves - whether the returned instance should be RFC6020 XML compliant.

Returns:

A new instance.

write

public NormalizedNodeWriter write(NormalizedNode<?,?> node)
                           throws IOException

Iterate over the provided NormalizedNode and emit write events to the encapsulated NormalizedNodeStreamWriter.

Parameters:

node - Node

Returns:

NormalizedNodeWriter this

Throws:

IOException - when thrown from the backing writer.

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

childSizeHint

protected static int childSizeHint(Iterable<?> children)

Emit a best guess of a hint for a particular set of children. It evaluates the iterable to see if the size can be easily gotten to. If it is, we hint at the real number of child nodes. Otherwise we emit UNKNOWN_SIZE.

Parameters:

children - Child nodes

Returns:

Best estimate of the collection size required to hold all the children.

wasProcessAsSimpleNode

protected boolean wasProcessAsSimpleNode(NormalizedNode<?,?> node)
                                  throws IOException

Throws:

IOException

writeChildren

protected boolean writeChildren(Iterable<? extends NormalizedNode<?,?>> children)
                         throws IOException

Emit events for all children and then emit an endNode() event.

Parameters:

children - Child iterable

Returns:

True

Throws:

IOException - when the writer reports it

writeMapEntryNode

protected boolean writeMapEntryNode(MapEntryNode node)
                             throws IOException

Throws:

IOException

wasProcessedAsCompositeNode

protected boolean wasProcessedAsCompositeNode(NormalizedNode<?,?> node)
                                       throws IOException

Throws:

IOException