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

Interface NormalizedNodeStreamWriter

All Superinterfaces:

AutoCloseable, Closeable, Flushable

All Known Subinterfaces:

NormalizedNodeStreamAttributeWriter

All Known Implementing Classes:

ForwardingNormalizedNodeStreamAttributeWriter, ForwardingNormalizedNodeStreamWriter, ImmutableNormalizedNodeStreamWriter, JSONNormalizedNodeStreamWriter, LoggingNormalizedNodeStreamWriter, QNameTransformingStreamWriter, XMLStreamNormalizedNodeStreamWriter

public interface NormalizedNodeStreamWriter
extends Closeable, Flushable

Event Stream Writer based on Normalized Node tree representation

Writing Event Stream

• container - Container node representation, start event is emitted using #startContainerNode(NodeIdentifier, int) and node end event is emitted using endNode(). Container node is implementing the org.opendaylight.yangtools.yang.binding.DataObject interface.
• list - YANG list statement has two representation in event stream - unkeyed list and map. Unkeyed list is YANG list which did not specify key.
  • Map - Map start event is emitted using #startMapNode(NodeIdentifier, int) and is ended using endNode(). Each map entry start is emitted using #startMapEntryNode(NodeIdentifierWithPredicates, int) with Map of keys and finished using endNode().
  • UnkeyedList - Unkeyed list represent list without keys, unkeyed list start is emitted using #startUnkeyedList(NodeIdentifier, int) list end is emitted using endNode(). Each list item is emitted using #startUnkeyedListItem(NodeIdentifier, int) and ended using endNode().
• leaf - Leaf node event is emitted using #leafNode(NodeIdentifier, Object). endNode() MUST NOT BE emitted for leaf node.
• leaf-list - Leaf list start is emitted using #startLeafSet(NodeIdentifier, int). Leaf list end is emitted using endNode(). Leaf list entries are emmited using leafSetEntryNode(QName, Object).
• anyxml - AN node event is emitted using #leafNode(NodeIdentifier, Object). endNode() MUST NOT BE emitted for anyxml node.
• choice Choice node event is emmited by #startChoiceNode(NodeIdentifier, int) event and finished by invoking endNode()
• augment - Represents augmentation, augmentation node is started by invoking #startAugmentationNode(AugmentationIdentifier) and finished by invoking endNode().

Implementation notes

Implementations of this interface must not hold user suppled objects and resources needlessly.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_SIZE Methods in this interface allow users to hint the underlying implementation about the sizing of container-like constructors (leafLists, containers, etc.).

Method Summary

Modifier and Type	Method and Description
void	anyxmlNode(YangInstanceIdentifier.NodeIdentifier name, Object value) Emits anyxml node event.
void	close()
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.
default void	nextDataSchemaNode(DataSchemaNode schema) Attach the specified DataSchemaNode to the next node which will get started or emitted.
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.

Field Detail

UNKNOWN_SIZE

static final int UNKNOWN_SIZE

Methods in this interface allow users to hint the underlying implementation about the sizing of container-like constructors (leafLists, containers, etc.). These hints may be taken into account by a particular implementation to improve performance, but clients are not required to provide hints. This constant should be used by clients who either do not have the sizing information, or do not wish to divulge it (for whatever reasons). Implementations are free to ignore these hints completely, but if they do use them, they are expected to be resilient in face of missing and mismatched hints, which is to say the user can specify startLeafSet(..., 1) and then call leafNode() 15 times.

The acceptable hint values are non-negative integers and this constant, all other values will result, based on implementation preference, in the hint being completely ignored or IllegalArgumentException being thrown.

See Also:

Constant Field Values

Method Detail

leafNode

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

Emits a leaf node event with supplied value.

Parameters:

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

value - Value of leaf node. v

Throws:

IllegalArgumentException - If emitted leaf node has invalid value in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

startLeafSet

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

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

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

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 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:

IllegalArgumentException - If emitted leaf node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

startOrderedLeafSet

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

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

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

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 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:

IllegalArgumentException - If emitted leaf node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

leafSetEntryNode

void leafSetEntryNode(QName name,
                      Object value)
               throws IOException

Emits a leaf set entry node.

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:

IllegalArgumentException - If emitted leaf node has invalid value.

IllegalStateException - If node was emitted outside leaf set node.

IOException - if an underlying IO error occurs

startContainerNode

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

Emits start of new container.

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

Valid sub-events are:

• 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)

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 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:

IllegalArgumentException - If emitted node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

startUnkeyedList

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

Emits start of unkeyed list node event.

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

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 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:

IllegalArgumentException - If emitted node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

startUnkeyedListItem

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

Emits start of new unkeyed list item.

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

• 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)

Parameters:

name - Identifier of node

childSizeHint - Non-negative count of expected direct child nodes or 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:

IllegalStateException - If node was emitted outside unkeyed list node.

IOException - if an underlying IO error occurs

startMapNode

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

Emits start of map node event.

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

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 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:

IllegalArgumentException - If emitted node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

startMapEntryNode

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

Emits start of map entry.

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

Valid sub-events are:

• 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)

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 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:

IllegalArgumentException - If key contains incorrect value.

IllegalStateException - If node was emitted outside map entry node.

IOException - if an underlying IO error occurs

startOrderedMapNode

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

Emits start of map node event.

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

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 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:

IllegalArgumentException - If emitted node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

startChoiceNode

void startChoiceNode(YangInstanceIdentifier.NodeIdentifier name,
                     int childSizeHint)
              throws IOException

Emits start of a choice node event.

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 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:

IllegalArgumentException - If emitted node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

startAugmentationNode

void startAugmentationNode(YangInstanceIdentifier.AugmentationIdentifier identifier)
                    throws IOException

Emits start of augmentation node.

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

Valid sub-events are:

• 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)

Parameters:

identifier - Augmentation identifier

Throws:

IllegalArgumentException - If augmentation is invalid in current context.

IOException - if an underlying IO error occurs

anyxmlNode

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

Emits anyxml node event.

Parameters:

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

value - Value of AnyXml node.

Throws:

IllegalArgumentException - If emitted node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

startYangModeledAnyXmlNode

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

Emits start of new yang modeled anyXml node.

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

Valid sub-events are:

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

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 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:

IllegalArgumentException - If emitted node is invalid in current context or was emitted multiple times.

IllegalStateException - If node was emitted inside map, choice unkeyed list node.

IOException - if an underlying IO error occurs

endNode

void endNode()
      throws IOException

Emits end event for node.

Throws:

IllegalStateException - If there is no start* event to be closed.

IOException - if an underlying IO error occurs

nextDataSchemaNode

default void nextDataSchemaNode(@Nonnull
                                DataSchemaNode schema)

Attach the specified DataSchemaNode to the next node which will get started or emitted. The default implementation does nothing.

Parameters:

schema - DataSchemaNode

Throws:

NullPointerException - if the argument is null

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

flush

void flush()
    throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException