org.opendaylight.mdsal.binding.javav2.dom.codec.impl.serializer

Class BindingToNormalizedStreamWriter

java.lang.Object

org.opendaylight.mdsal.binding.javav2.dom.codec.impl.serializer.BindingToNormalizedStreamWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, BindingStreamEventWriter, org.opendaylight.yangtools.concepts.Delegator<org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter>

@Beta
public final class BindingToNormalizedStreamWriter
extends Object
implements BindingStreamEventWriter, org.opendaylight.yangtools.concepts.Delegator<org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter>

Stream event writer of Binding v2 representation.

Field Summary

Fields inherited from interface org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingStreamEventWriter

UNKNOWN_SIZE

Method Summary

Modifier and Type	Method and Description
void	anyxmlNode(String name, Object value) Emits anyxml node event.
void	close()
static BindingToNormalizedStreamWriter	create(NodeCodecContext<?> schema, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter delegate) Create instance of Binding v2 representation writer.
void	endNode() Emits end event for node.
void	flush()
org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	getDelegate()
void	leafNode(String localName, Object value) Emits a leaf node event with supplied value.
void	leafSetEntryNode(Object value) Emits a leaf set entry node
void	startAnydataNode(String name, Object value) Emits anydata node event.
void	startAugmentationNode(Class<? extends Augmentation<?>> augmentationType) Emits start of augmentation node.
void	startCase(Class<? extends TreeNode> caze, int childSizeHint) Starts a case node.
<T extends TreeNode> void	startChoiceNode(Item<T> choice, int childSizeHint) Emits start of choice node.
void	startContainerNode(Class<? extends TreeNode> object, int childSizeHint) Emits start of new container.
void	startLeafSet(String localName, int childSizeHint) Emits a start of leaf set (leaf-list).
<I extends TreeNode,T> void	startMapEntryNode(IdentifiableItem<I,T> keyValues, int childSizeHint) Emits start of map entry.
<T extends TreeNode & org.opendaylight.yangtools.concepts.Identifiable<?>> void	startMapNode(Class<T> mapEntryType, int childSizeHint) Emits start of unordered map node event.
void	startOrderedLeafSet(String localName, int childSizeHint) Emits a start of leaf set (leaf-list).
<T extends TreeNode & org.opendaylight.yangtools.concepts.Identifiable<?>> void	startOrderedMapNode(Class<T> mapEntryType, int childSizeHint) Emits start of ordered map node event.
void	startUnkeyedList(Class<? extends TreeNode> localName, int childSizeHint) Emits start of unkeyed list node event.
void	startUnkeyedListItem(int childSizeHint) Emits start of new unkeyed list item.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static BindingToNormalizedStreamWriter create(NodeCodecContext<?> schema,
                                                     org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter delegate)

Create instance of Binding v2 representation writer.

Parameters:

schema - - codec schema

delegate - - DOM writer delegator

Returns:

instance of binding writer

getDelegate

public org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter getDelegate()

Specified by:

getDelegate in interface org.opendaylight.yangtools.concepts.Delegator<org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter>

endNode

public void endNode()
             throws IOException

Description copied from interface: BindingStreamEventWriter

Emits end event for node.

Specified by:

endNode in interface BindingStreamEventWriter

Throws:

IOException - if an underlying IO error occurs

leafNode

public void leafNode(String localName,
                     Object value)
              throws IOException

Description copied from interface: BindingStreamEventWriter

Emits a leaf node event with supplied value.

Specified by:

leafNode in interface BindingStreamEventWriter

Parameters:

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

value - Value of leaf node.

Throws:

IOException - if an underlying IO error occurs

anyxmlNode

public void anyxmlNode(String name,
                       Object value)
                throws IOException

Description copied from interface: BindingStreamEventWriter

Emits anyxml node event.

Specified by:

anyxmlNode in interface BindingStreamEventWriter

Throws:

IOException - if an underlying IO error occurs

leafSetEntryNode

public void leafSetEntryNode(Object value)
                      throws IOException

Description copied from interface: BindingStreamEventWriter

Emits a leaf set entry node

Specified by:

leafSetEntryNode in interface BindingStreamEventWriter

Parameters:

value - Value of leaf set entry node.

Throws:

IOException - if an underlying IO error occurs

startAugmentationNode

public void startAugmentationNode(Class<? extends Augmentation<?>> augmentationType)
                           throws IOException

Description copied from interface: BindingStreamEventWriter

Emits start of augmentation node.

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

Valid sub-events are:

• BindingStreamEventWriter.leafNode(String, Object)
• BindingStreamEventWriter.startContainerNode(Class, int)
• BindingStreamEventWriter.startChoiceNode(Item, int)
• BindingStreamEventWriter.startLeafSet(String, int)
• BindingStreamEventWriter.startMapNode(Class, int)
• BindingStreamEventWriter.startUnkeyedList(Class, int)

Note this is only method, which does not require childSizeHint, since maximum value is always size of possibleChildren.

Specified by:

startAugmentationNode in interface BindingStreamEventWriter

Parameters:

augmentationType - augmentation class

Throws:

IOException - if an underlying IO error occurs

startCase

public void startCase(Class<? extends TreeNode> caze,
                      int childSizeHint)

Description copied from interface: BindingStreamEventWriter

Starts a case node.

Valid sub-events are:

• BindingStreamEventWriter.leafNode(String, Object)
• BindingStreamEventWriter.startContainerNode(Class, int)
• BindingStreamEventWriter.startChoiceNode(Item, int)
• BindingStreamEventWriter.startLeafSet(String, int)
• BindingStreamEventWriter.startMapNode(Class, int)
• BindingStreamEventWriter.startUnkeyedList(Class, int)
• BindingStreamEventWriter.startAugmentationNode(Class)

Specified by:

startCase in interface BindingStreamEventWriter

Parameters:

caze - Case class

startChoiceNode

public <T extends TreeNode> void startChoiceNode(Item<T> choice,
                                                 int childSizeHint)
                                          throws IOException

Description copied from interface: BindingStreamEventWriter

Emits start of choice node.

Valid sub-event is BindingStreamEventWriter.startCase(Class, int), which selects case which should be written.

Specified by:

startChoiceNode in interface BindingStreamEventWriter

Parameters:

choice - Choice class.

childSizeHint - Non-negative count of expected direct child nodes or BindingStreamEventWriter.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 void startContainerNode(Class<? extends TreeNode> object,
                               int childSizeHint)
                        throws IOException

Description copied from interface: BindingStreamEventWriter

Emits start of new container.

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

Valid sub-events are:

• BindingStreamEventWriter.leafNode(String, Object)
• BindingStreamEventWriter.startContainerNode(Class, int)
• BindingStreamEventWriter.startChoiceNode(Item, int)
• BindingStreamEventWriter.startLeafSet(String, int)
• BindingStreamEventWriter.startMapNode(Class, int)
• BindingStreamEventWriter.startUnkeyedList(Class, int)
• BindingStreamEventWriter.startAugmentationNode(Class)

Specified by:

startContainerNode in interface BindingStreamEventWriter

Parameters:

object - 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 BindingStreamEventWriter.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

startLeafSet

public void startLeafSet(String localName,
                         int childSizeHint)
                  throws IOException

Description copied from interface: BindingStreamEventWriter

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

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

Specified by:

startLeafSet in interface BindingStreamEventWriter

Parameters:

localName - 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 BindingStreamEventWriter.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

startOrderedLeafSet

public void startOrderedLeafSet(String localName,
                                int childSizeHint)
                         throws IOException

Description copied from interface: BindingStreamEventWriter

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

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

Specified by:

startOrderedLeafSet in interface BindingStreamEventWriter

Parameters:

localName - 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 BindingStreamEventWriter.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 <I extends TreeNode,T> void startMapEntryNode(IdentifiableItem<I,T> keyValues,
                                                     int childSizeHint)
                                              throws IOException

Description copied from interface: BindingStreamEventWriter

Emits start of map entry.

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

Valid sub-events are:

• BindingStreamEventWriter.leafNode(String, Object)
• BindingStreamEventWriter.startContainerNode(Class, int)
• BindingStreamEventWriter.startChoiceNode(Item, int)
• BindingStreamEventWriter.startLeafSet(String, int)
• BindingStreamEventWriter.startMapNode(Class, int)
• BindingStreamEventWriter.startUnkeyedList(Class, int)
• BindingStreamEventWriter.startAugmentationNode(Class)

Specified by:

startMapEntryNode in interface BindingStreamEventWriter

Parameters:

keyValues - Key of map entry node

childSizeHint - Non-negative count of expected direct child nodes or BindingStreamEventWriter.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 <T extends TreeNode & org.opendaylight.yangtools.concepts.Identifiable<?>> void startMapNode(Class<T> mapEntryType,
                                                                                                    int childSizeHint)
                                                                                             throws IOException

Description copied from interface: BindingStreamEventWriter

Emits start of unordered map node event.

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

Specified by:

startMapNode in interface BindingStreamEventWriter

Parameters:

mapEntryType - Class of list.

childSizeHint - Non-negative count of expected direct child nodes or BindingStreamEventWriter.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 <T extends TreeNode & org.opendaylight.yangtools.concepts.Identifiable<?>> void startOrderedMapNode(Class<T> mapEntryType,
                                                                                                           int childSizeHint)
                                                                                                    throws IOException

Description copied from interface: BindingStreamEventWriter

Emits start of ordered map node event.

End of map node event is emitted by invoking BindingStreamEventWriter.endNode(). Valid sub-event is only BindingStreamEventWriter.startMapEntryNode(IdentifiableItem, int). All other methods will throw IllegalArgumentException.

Specified by:

startOrderedMapNode in interface BindingStreamEventWriter

Parameters:

mapEntryType - Class of list item, which has defined key.

childSizeHint - Non-negative count of expected direct child nodes or BindingStreamEventWriter.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 void startUnkeyedList(Class<? extends TreeNode> localName,
                             int childSizeHint)
                      throws IOException

Description copied from interface: BindingStreamEventWriter

Emits start of unkeyed list node event.

End of unkeyed list event is emitted by invoking BindingStreamEventWriter.endNode(). Valid sub-event is only BindingStreamEventWriter.startUnkeyedListItem(int). All other methods will throw IllegalArgumentException.

Specified by:

startUnkeyedList in interface BindingStreamEventWriter

Parameters:

localName - 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 BindingStreamEventWriter.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 void startUnkeyedListItem(int childSizeHint)
                          throws IOException

Description copied from interface: BindingStreamEventWriter

Emits start of new unkeyed list item.

Un-keyed list item event is finished by invoking BindingStreamEventWriter.endNode().

Valid sub-events are:

• BindingStreamEventWriter.leafNode(String, Object)
• BindingStreamEventWriter.startContainerNode(Class, int)
• BindingStreamEventWriter.startChoiceNode(Item, int)
• BindingStreamEventWriter.startLeafSet(String, int)
• BindingStreamEventWriter.startMapNode(Class, int)
• BindingStreamEventWriter.startUnkeyedList(Class, int)
• BindingStreamEventWriter.startAugmentationNode(Class)

Specified by:

startUnkeyedListItem in interface BindingStreamEventWriter

Parameters:

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

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in interface BindingStreamEventWriter

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BindingStreamEventWriter

Throws:

IOException

startAnydataNode

public void startAnydataNode(String name,
                             Object value)
                      throws IOException

Description copied from interface: BindingStreamEventWriter

Emits anydata node event.

Specified by:

startAnydataNode in interface BindingStreamEventWriter

Throws:

IOException - if an underlying IO error occurs