org.opendaylight.yangtools.yang.data.codec.gson

Class JSONNormalizedNodeStreamWriter

java.lang.Object

org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, NormalizedNodeStreamWriter

public abstract class JSONNormalizedNodeStreamWriter
extends Object
implements NormalizedNodeStreamWriter

This implementation will create JSON output as output stream.

Values of leaf and leaf-list are NOT translated according to codecs.

Field Summary

Fields inherited from interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

UNKNOWN_SIZE

Method Summary

Modifier and Type	Method and Description
void	anyxmlNode(YangInstanceIdentifier.NodeIdentifier name, Object value) Emits anyxml node event.
static NormalizedNodeStreamWriter	createExclusiveWriter(JSONCodecFactory codecFactory, DataNodeContainer rootNode, URI initialNs, com.google.gson.stream.JsonWriter jsonWriter) Create a new stream writer, which writes to the specified output stream.
static NormalizedNodeStreamWriter	createExclusiveWriter(JSONCodecFactory codecFactory, SchemaPath path, URI initialNs, com.google.gson.stream.JsonWriter jsonWriter) Create a new stream writer, which writes to the specified output stream.
static NormalizedNodeStreamWriter	createNestedWriter(JSONCodecFactory codecFactory, DataNodeContainer rootNode, URI initialNs, com.google.gson.stream.JsonWriter jsonWriter) Create a new stream writer, which writes to the specified output stream.
static NormalizedNodeStreamWriter	createNestedWriter(JSONCodecFactory codecFactory, SchemaPath path, URI initialNs, com.google.gson.stream.JsonWriter jsonWriter) Create a new stream writer, which writes to the specified output stream.
void	endNode() Emits end event for node.
void	flush()
void	leafNode(YangInstanceIdentifier.NodeIdentifier name, Object value) Emits a leaf node event with supplied value.
void	leafSetEntryNode(QName name, Object value) Emits a leaf set entry node.
void	startAugmentationNode(YangInstanceIdentifier.AugmentationIdentifier identifier) Emits start of augmentation node.
void	startChoiceNode(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits start of a choice node event.
void	startContainerNode(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits start of new container.
void	startLeafSet(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits a start of leaf set (leaf-list).
void	startMapEntryNode(YangInstanceIdentifier.NodeIdentifierWithPredicates identifier, int childSizeHint) Emits start of map entry.
void	startMapNode(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits start of map node event.
void	startOrderedLeafSet(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits a start of leaf set (leaf-list).
void	startOrderedMapNode(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits start of map node event.
void	startUnkeyedList(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits start of unkeyed list node event.
void	startUnkeyedListItem(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits start of new unkeyed list item.
void	startYangModeledAnyXmlNode(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits start of new yang modeled anyXml node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

close, nextDataSchemaNode

Method Detail

createExclusiveWriter

public static NormalizedNodeStreamWriter createExclusiveWriter(JSONCodecFactory codecFactory,
                                                               SchemaPath path,
                                                               URI initialNs,
                                                               com.google.gson.stream.JsonWriter jsonWriter)

Create a new stream writer, which writes to the specified output stream.

The codec factory can be reused between multiple writers.

Returned writer is exclusive user of JsonWriter, which means it will start top-level JSON element and ends it.

This instance of writer can be used only to emit one top level element, otherwise it will produce incorrect JSON. Closing this instance will close the writer too.

Parameters:

codecFactory - JSON codec factory

path - Schema Path

initialNs - Initial namespace

jsonWriter - JsonWriter

Returns:

A stream writer instance

createExclusiveWriter

public static NormalizedNodeStreamWriter createExclusiveWriter(JSONCodecFactory codecFactory,
                                                               DataNodeContainer rootNode,
                                                               URI initialNs,
                                                               com.google.gson.stream.JsonWriter jsonWriter)

Create a new stream writer, which writes to the specified output stream.

The codec factory can be reused between multiple writers.

Returned writer is exclusive user of JsonWriter, which means it will start top-level JSON element and ends it.

This instance of writer can be used only to emit one top level element, otherwise it will produce incorrect JSON. Closing this instance will close the writer too.

Parameters:

codecFactory - JSON codec factory

rootNode - Root node

initialNs - Initial namespace

jsonWriter - JsonWriter

Returns:

A stream writer instance

createNestedWriter

public static NormalizedNodeStreamWriter createNestedWriter(JSONCodecFactory codecFactory,
                                                            SchemaPath path,
                                                            URI initialNs,
                                                            com.google.gson.stream.JsonWriter jsonWriter)

Create a new stream writer, which writes to the specified output stream.

The codec factory can be reused between multiple writers.

Returned writer can be used emit multiple top level element, but does not start / close parent JSON object, which must be done by user providing jsonWriter instance in order for JSON to be valid. Closing this instance will not close the wrapped writer; the caller must take care of that.

Parameters:

codecFactory - JSON codec factory

path - Schema Path

initialNs - Initial namespace

jsonWriter - JsonWriter

Returns:

A stream writer instance

createNestedWriter

public static NormalizedNodeStreamWriter createNestedWriter(JSONCodecFactory codecFactory,
                                                            DataNodeContainer rootNode,
                                                            URI initialNs,
                                                            com.google.gson.stream.JsonWriter jsonWriter)

Create a new stream writer, which writes to the specified output stream.

The codec factory can be reused between multiple writers.

Returned writer can be used emit multiple top level element, but does not start / close parent JSON object, which must be done by user providing jsonWriter instance in order for JSON to be valid. Closing this instance will not close the wrapped writer; the caller must take care of that.

Parameters:

codecFactory - JSON codec factory

rootNode - Root node

initialNs - Initial namespace

jsonWriter - JsonWriter

Returns:

A stream writer instance

leafNode

public final void leafNode(YangInstanceIdentifier.NodeIdentifier name,
                           Object value)
                    throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits a leaf node event with supplied value.

Specified by:

leafNode in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

value - Value of leaf node. v

Throws:

IOException - if an underlying IO error occurs

startLeafSet

public final void startLeafSet(YangInstanceIdentifier.NodeIdentifier name,
                               int childSizeHint)
                        throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits a start of leaf set (leaf-list).

Emits start of leaf set, during writing leaf set event, only NormalizedNodeStreamWriter.leafSetEntryNode(QName, Object) calls are valid. Leaf set event is finished by calling NormalizedNodeStreamWriter.endNode().

Specified by:

startLeafSet in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

leafSetEntryNode

public final void leafSetEntryNode(QName name,
                                   Object value)
                            throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits a leaf set entry node.

Specified by:

leafSetEntryNode in interface NormalizedNodeStreamWriter

Parameters:

name - name of the node as defined in the schema.

value - Value of leaf set entry node. Supplied object MUST BE constant over time.

Throws:

IOException - if an underlying IO error occurs

startOrderedLeafSet

public final void startOrderedLeafSet(YangInstanceIdentifier.NodeIdentifier name,
                                      int childSizeHint)
                               throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits a start of leaf set (leaf-list).

Emits start of leaf set, during writing leaf set event, only NormalizedNodeStreamWriter.leafSetEntryNode(QName, Object) calls are valid. Leaf set event is finished by calling NormalizedNodeStreamWriter.endNode().

Specified by:

startOrderedLeafSet in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

startContainerNode

public final void startContainerNode(YangInstanceIdentifier.NodeIdentifier name,
                                     int childSizeHint)
                              throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits start of new container.

End of container event is emitted by invoking NormalizedNodeStreamWriter.endNode().

Valid sub-events are:

• NormalizedNodeStreamWriter.leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, java.lang.Object)
• #startContainerNode(NodeIdentifier, int)
• #startChoiceNode(NodeIdentifier, int)
• #startLeafSet(NodeIdentifier, int)
• #startMapNode(NodeIdentifier, int)
• #startUnkeyedList(NodeIdentifier, int)
• #startAugmentationNode(AugmentationIdentifier)

Specified by:

startContainerNode in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

startUnkeyedList

public final void startUnkeyedList(YangInstanceIdentifier.NodeIdentifier name,
                                   int childSizeHint)
                            throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits start of unkeyed list node event.

End of unkeyed list event is emitted by invoking NormalizedNodeStreamWriter.endNode(). Valid subevents is only #startUnkeyedListItem(NodeIdentifier, int). All other methods will throw IllegalArgumentException.

Specified by:

startUnkeyedList in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

startUnkeyedListItem

public final void startUnkeyedListItem(YangInstanceIdentifier.NodeIdentifier name,
                                       int childSizeHint)
                                throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits start of new unkeyed list item.

Unkeyed list item event is finished by invoking NormalizedNodeStreamWriter.endNode(). Valid sub-events are:

• NormalizedNodeStreamWriter.leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, java.lang.Object)
• #startContainerNode(NodeIdentifier, int)
• #startChoiceNode(NodeIdentifier, int)
• #startLeafSet(NodeIdentifier, int)
• #startMapNode(NodeIdentifier, int)
• #startUnkeyedList(NodeIdentifier, int)
• #startAugmentationNode(AugmentationIdentifier)

Specified by:

startUnkeyedListItem in interface NormalizedNodeStreamWriter

Parameters:

name - Identifier of node

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

startMapNode

public final void startMapNode(YangInstanceIdentifier.NodeIdentifier name,
                               int childSizeHint)
                        throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits start of map node event.

End of map node event is emitted by invoking NormalizedNodeStreamWriter.endNode(). Valid subevents is only #startMapEntryNode(NodeIdentifierWithPredicates, int). All other methods will throw IllegalArgumentException.

Specified by:

startMapNode in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

startMapEntryNode

public final void startMapEntryNode(YangInstanceIdentifier.NodeIdentifierWithPredicates identifier,
                                    int childSizeHint)
                             throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits start of map entry.

End of map entry event is emitted by invoking NormalizedNodeStreamWriter.endNode().

Valid sub-events are:

• NormalizedNodeStreamWriter.leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, java.lang.Object)
• #startContainerNode(NodeIdentifier, int)
• #startChoiceNode(NodeIdentifier, int)
• #startLeafSet(NodeIdentifier, int)
• #startMapNode(NodeIdentifier, int)
• #startUnkeyedList(NodeIdentifier, int)
• #startAugmentationNode(AugmentationIdentifier)

Specified by:

startMapEntryNode in interface NormalizedNodeStreamWriter

Parameters:

identifier - QName to value pairs of keys of map entry node. Values MUST BE constant over time.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

startOrderedMapNode

public final void startOrderedMapNode(YangInstanceIdentifier.NodeIdentifier name,
                                      int childSizeHint)
                               throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits start of map node event.

End of map node event is emitted by invoking NormalizedNodeStreamWriter.endNode(). Valid subevents is only #startMapEntryNode(NodeIdentifierWithPredicates, int). All other methods will throw IllegalArgumentException.

Specified by:

startOrderedMapNode in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

startChoiceNode

public final void startChoiceNode(YangInstanceIdentifier.NodeIdentifier name,
                                  int childSizeHint)

Description copied from interface: NormalizedNodeStreamWriter

Emits start of a choice node event.

Specified by:

startChoiceNode in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

startAugmentationNode

public final void startAugmentationNode(YangInstanceIdentifier.AugmentationIdentifier identifier)

Description copied from interface: NormalizedNodeStreamWriter

Emits start of augmentation node.

End of augmentation event is emitted by invoking NormalizedNodeStreamWriter.endNode().

Valid sub-events are:

• NormalizedNodeStreamWriter.leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, java.lang.Object)
• #startContainerNode(NodeIdentifier, int)
• #startChoiceNode(NodeIdentifier, int)
• #startLeafSet(NodeIdentifier, int)
• #startMapNode(NodeIdentifier, int)
• #startUnkeyedList(NodeIdentifier, int)

Specified by:

startAugmentationNode in interface NormalizedNodeStreamWriter

Parameters:

identifier - Augmentation identifier

anyxmlNode

public final void anyxmlNode(YangInstanceIdentifier.NodeIdentifier name,
                             Object value)
                      throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits anyxml node event.

Specified by:

anyxmlNode in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

value - Value of AnyXml node.

Throws:

IOException - if an underlying IO error occurs

startYangModeledAnyXmlNode

public final void startYangModeledAnyXmlNode(YangInstanceIdentifier.NodeIdentifier name,
                                             int childSizeHint)
                                      throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits start of new yang modeled anyXml node.

End of yang modeled anyXml node event is emitted by invoking NormalizedNodeStreamWriter.endNode().

Valid sub-events are:

• NormalizedNodeStreamWriter.leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, java.lang.Object)
• NormalizedNodeStreamWriter.startContainerNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, int)
• NormalizedNodeStreamWriter.startLeafSet(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, int)
• NormalizedNodeStreamWriter.startMapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, int)
• NormalizedNodeStreamWriter.startUnkeyedList(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, int)

Specified by:

startYangModeledAnyXmlNode in interface NormalizedNodeStreamWriter

Parameters:

name - name of node as defined in schema, namespace and revision are derived from parent node.

childSizeHint - Non-negative count of expected direct child nodes or NormalizedNodeStreamWriter.UNKNOWN_SIZE if count is unknown. This is only hint and should not fail writing of child events, if there are more events than count.

Throws:

IOException - if an underlying IO error occurs

endNode

public final void endNode()
                   throws IOException

Description copied from interface: NormalizedNodeStreamWriter

Emits end event for node.

Specified by:

endNode in interface NormalizedNodeStreamWriter

Throws:

IOException - if an underlying IO error occurs

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in interface NormalizedNodeStreamWriter

Throws:

IOException