org.opendaylight.yangtools.transform

Class QNameTransformingStreamWriter

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.yangtools.transform.QNameTransformingStreamWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, NormalizedNodeStreamWriter

public abstract class QNameTransformingStreamWriter
extends com.google.common.collect.ForwardingObject
implements NormalizedNodeStreamWriter

Stateless Normalized Node Stream Writer decorator, which performs QName translation. This class serves as base for Normalized Node Stream Writer decorators with option to transform QNames by user-implemented transform(QName) function.

Field Summary

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

UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor and Description
QNameTransformingStreamWriter()

Method Summary

Methods

Modifier and Type	Method and Description
void	anyxmlNode(YangInstanceIdentifier.NodeIdentifier name, Object value) Emits anyxml node event.
void	close()
static NormalizedNodeStreamWriter	createQNameModuleReplacing(NormalizedNodeStreamWriter delegate, Map<QNameModule,QNameModule> mapping) Returns decorator, which uses supplied map to transform QNameModules.
static NormalizedNodeStreamWriter	createQNameReplacing(NormalizedNodeStreamWriter delegate, Map<QName,QName> mapping) Returns decorator, which uses supplied map to transform QNames.
protected abstract NormalizedNodeStreamWriter	delegate()
void	endNode() Emits end event for node.
void	flush()
static NormalizedNodeStreamWriter	fromFunction(NormalizedNodeStreamWriter delegate, com.google.common.base.Function<QName,QName> transformation) Returns decorator, which uses supplied function to transform QNames.
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)
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.
protected abstract QName	transform(QName key) Transforms a QName to new mapping.

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

QNameTransformingStreamWriter

public QNameTransformingStreamWriter()

Method Detail

delegate

protected abstract NormalizedNodeStreamWriter delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingObject

fromFunction

public static NormalizedNodeStreamWriter fromFunction(NormalizedNodeStreamWriter delegate,
                                      com.google.common.base.Function<QName,QName> transformation)

Returns decorator, which uses supplied function to transform QNames.

Parameters:

delegate - Underlying normalized node stream writer

transformation - Transformation function, function is required to return non-null values.

Returns:

decorator, which uses supplied function to transform QNames.

createQNameReplacing

public static NormalizedNodeStreamWriter createQNameReplacing(NormalizedNodeStreamWriter delegate,
                                              Map<QName,QName> mapping)

Returns decorator, which uses supplied map to transform QNames. QNames not present in map are left unchanged.

Parameters:

delegate - Underlying normalized node stream writer

mapping - Immutable map which represent mapping from original to new values.

Returns:

decorator, which uses supplied mapping to transform QNames.

createQNameModuleReplacing

public static NormalizedNodeStreamWriter createQNameModuleReplacing(NormalizedNodeStreamWriter delegate,
                                                    Map<QNameModule,QNameModule> mapping)

Returns decorator, which uses supplied map to transform QNameModules. QNameModules not present in map are left unchanged.

Parameters:

delegate - Underlying normalized node stream writer

mapping - Immutable map which represent mapping from original to new values.

Returns:

decorator, which uses supplied mapping to transform QNameModules.

transform

@Nonnull
protected abstract QName transform(@Nonnull
                      QName key)

Transforms a QName to new mapping. NOTE: If QName should be unchanged implementation needs to return original QName.

Parameters:

key - QName to transform.

Returns:

Returns new value of QName.

leafNode

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

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

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

startLeafSet

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

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

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

startOrderedLeafSet

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

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

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

leafSetEntryNode

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

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

IllegalArgumentException - If emitted leaf node has invalid value.

startContainerNode

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

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

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

startUnkeyedList

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

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

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

startUnkeyedListItem

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

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

IllegalStateException - If node was emitted outside unkeyed list node.

startMapNode

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

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

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

startMapEntryNode

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

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

IllegalArgumentException - If key contains incorrect value.

startOrderedMapNode

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

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

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

startChoiceNode

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

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.

Throws:

IOException - if an underlying IO error occurs

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

startAugmentationNode

public void startAugmentationNode(YangInstanceIdentifier.AugmentationIdentifier identifier)
                           throws IOException,
                                  IllegalArgumentException

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

Throws:

IOException - if an underlying IO error occurs

IllegalArgumentException - If augmentation is invalid in current context.

anyxmlNode

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

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

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

startYangModeledAnyXmlNode

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

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

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

endNode

public void endNode()
             throws IOException,
                    IllegalStateException

Description copied from interface: NormalizedNodeStreamWriter

Emits end event for node.

Specified by:

endNode in interface NormalizedNodeStreamWriter

Throws:

IOException - if an underlying IO error occurs

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

close

public 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 void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in interface NormalizedNodeStreamWriter

Throws:

IOException