org.opendaylight.yangtools.yang.data.codec.xml

Class XMLStreamNormalizedNodeStreamWriter<T>

java.lang.Object

org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter<T>

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, NormalizedNodeStreamAttributeWriter, NormalizedNodeStreamWriter

public abstract class XMLStreamNormalizedNodeStreamWriter<T>
extends Object
implements NormalizedNodeStreamAttributeWriter

A NormalizedNodeStreamWriter which translates the events into an XMLStreamWriter, resulting in a RFC 6020 XML encoding. There are 2 versions of this class, one that takes a SchemaContext and encodes values appropriately according to the yang schema. The other is schema-less and merely outputs values using toString. The latter is intended for debugging where doesn't have a SchemaContext available and isn't meant for production use.

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	close()
static @NonNull NormalizedNodeStreamWriter	create(XMLStreamWriter writer, SchemaContext context) Create a new writer with the specified context as its root.
static @NonNull NormalizedNodeStreamWriter	create(XMLStreamWriter writer, SchemaContext context, DataNodeContainer rootNode) Create a new writer with the specified context and rooted at the specified node.
static @NonNull NormalizedNodeStreamWriter	create(XMLStreamWriter writer, SchemaContext context, SchemaPath path) Create a new writer with the specified context and rooted in the specified schema path.
static @NonNull NormalizedNodeStreamWriter	createSchemaless(XMLStreamWriter writer) Create a new schema-less writer.
void	flush()
void	startContainerNode(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint, Map<QName,String> attributes)
void	startMapEntryNode(YangInstanceIdentifier.NodeIdentifierWithPredicates identifier, int childSizeHint) Emits start of map entry.
void	startMapEntryNode(YangInstanceIdentifier.NodeIdentifierWithPredicates identifier, int childSizeHint, Map<QName,String> attributes)
void	startMapNode(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint) Emits start of map node event.
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	startUnkeyedListItem(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint, Map<QName,String> attributes)
void	startYangModeledAnyXmlNode(YangInstanceIdentifier.NodeIdentifier name, int childSizeHint, Map<QName,String> attributes)
static String	toString(Element xml) Deprecated. This method not used anywhere, users are advised to use their own formatting.

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.NormalizedNodeStreamAttributeWriter

leafNode, leafSetEntryNode

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

anyxmlNode, endNode, leafNode, leafSetEntryNode, nextDataSchemaNode, startAugmentationNode, startChoiceNode, startContainerNode, startLeafSet, startOrderedLeafSet, startYangModeledAnyXmlNode

Method Detail

create

public static @NonNull NormalizedNodeStreamWriter create(XMLStreamWriter writer,
                                                         SchemaContext context)

Create a new writer with the specified context as its root.

Parameters:

writer - Output XMLStreamWriter

context - Associated SchemaContext.

Returns:

A new NormalizedNodeStreamWriter

create

public static @NonNull NormalizedNodeStreamWriter create(XMLStreamWriter writer,
                                                         SchemaContext context,
                                                         DataNodeContainer rootNode)

Create a new writer with the specified context and rooted at the specified node.

Parameters:

writer - Output XMLStreamWriter

context - Associated SchemaContext.

rootNode - Root node

Returns:

A new NormalizedNodeStreamWriter

create

public static @NonNull NormalizedNodeStreamWriter create(XMLStreamWriter writer,
                                                         SchemaContext context,
                                                         SchemaPath path)

Create a new writer with the specified context and rooted in the specified schema path.

Parameters:

writer - Output XMLStreamWriter

context - Associated SchemaContext.

path - path

Returns:

A new NormalizedNodeStreamWriter

createSchemaless

public static @NonNull NormalizedNodeStreamWriter createSchemaless(XMLStreamWriter writer)

Create a new schema-less writer. Note that this version is intended for debugging where doesn't have a SchemaContext available and isn't meant for production use.

Parameters:

writer - Output XMLStreamWriter

Returns:

A new NormalizedNodeStreamWriter

toString

@Deprecated
public static String toString(Element xml)

Deprecated. This method not used anywhere, users are advised to use their own formatting.

Utility method for formatting an Element to a string.

startContainerNode

public final void startContainerNode(YangInstanceIdentifier.NodeIdentifier name,
                                     int childSizeHint,
                                     Map<QName,String> attributes)
                              throws IOException

Specified by:

startContainerNode in interface NormalizedNodeStreamAttributeWriter

Throws:

IOException

startYangModeledAnyXmlNode

public final void startYangModeledAnyXmlNode(YangInstanceIdentifier.NodeIdentifier name,
                                             int childSizeHint,
                                             Map<QName,String> attributes)
                                      throws IOException

Specified by:

startYangModeledAnyXmlNode in interface NormalizedNodeStreamAttributeWriter

Throws:

IOException

startUnkeyedListItem

public final void startUnkeyedListItem(YangInstanceIdentifier.NodeIdentifier name,
                                       int childSizeHint,
                                       Map<QName,String> attributes)
                                throws IOException

Specified by:

startUnkeyedListItem in interface NormalizedNodeStreamAttributeWriter

Throws:

IOException

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

startMapEntryNode

public final void startMapEntryNode(YangInstanceIdentifier.NodeIdentifierWithPredicates identifier,
                                    int childSizeHint,
                                    Map<QName,String> attributes)
                             throws IOException

Specified by:

startMapEntryNode in interface NormalizedNodeStreamAttributeWriter

Throws:

IOException

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

startUnkeyedList

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

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.

startMapNode

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

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.

startOrderedMapNode

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

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.

close

public final void close()
                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NormalizedNodeStreamWriter

Throws:

IOException

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in interface NormalizedNodeStreamWriter

Throws:

IOException