org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.base

Class DataContainerCodecContext<D extends TreeNode,T>

java.lang.Object

org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.base.NodeCodecContext<D>

org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.base.DataContainerCodecContext<D,T>

All Implemented Interfaces:

BindingNormalizedNodeCodec<D>, BindingTreeNodeCodec<D>

Direct Known Subclasses:

ChoiceNodeCodecContext, SchemaRootCodecContext, TreeNodeCodecContext

@Beta
public abstract class DataContainerCodecContext<D extends TreeNode,T>
extends NodeCodecContext<D>

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.base.NodeCodecContext

NodeCodecContext.CodecContextFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataContainerCodecContext(DataContainerCodecPrototype<T> prototype)

Method Summary

Modifier and Type	Method and Description
protected TreeArgument	bindingArg()
DataContainerCodecContext<?,?>	bindingPathArgumentChild(TreeArgument<?> arg, List<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> builder) Returns nested node context using supplied Binding Instance Identifier and adds YANG instance identifiers to supplied list.
protected <V> V	childNonNull(V nullable, Class<?> childClass, String message, Object... args)
protected <V> V	childNonNull(V nullable, org.opendaylight.yangtools.yang.common.QName child, String message, Object... args)
protected <V> V	childNonNull(V nullable, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child, String message, Object... args)
BindingNormalizedNodeCachingCodec<D>	createCachingCodec(com.google.common.collect.ImmutableCollection<Class<? extends TreeNode>> cacheSpecifier) Returns codec which uses caches serialization / deserialization results.
BindingStreamEventWriter	createWriter(org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)
TreeNodeSerializer	eventStreamSerializer()
protected NodeCodecContext.CodecContextFactory	factory()
Class<D>	getBindingClass() Returns binding class of interface which represents API of current schema node.
protected TreeArgument	getBindingPathArgument(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument domArg) Returns de-serialized Binding Path Argument from YANG instance identifier.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument	getDomPathArgument() Returns Yang Instance Identifier Path Argument of current node.
T	getSchema() Return schema of node codec context.
protected org.opendaylight.yangtools.yang.common.QNameModule	namespace()
abstract <C extends TreeNode> Optional<DataContainerCodecContext<C,?>>	possibleStreamChild(Class<C> childClass) Returns child context as if it was walked by BindingStreamEventWriter.
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	serialize(D data) Converts from Binding to Normalized Node representation of data.
abstract <C extends TreeNode> DataContainerCodecContext<C,?>	streamChild(Class<C> childClass) Returns child context as if it was walked by BindingStreamEventWriter.
String	toString()
void	writeAsNormalizedNode(D data, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter writer) Writes data representing object to supplied stream.
abstract NodeCodecContext<?>	yangPathArgumentChild(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument arg) Returns nested node context using supplied YANG Instance Identifier.

Methods inherited from class org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.base.NodeCodecContext

addYangPathArgument, deserializeObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.mdsal.binding.javav2.dom.codec.api.BindingTreeNodeCodec

deserializePathArgument, serializePathArgument

Methods inherited from interface org.opendaylight.mdsal.binding.javav2.dom.codec.api.BindingNormalizedNodeCodec

deserialize

Constructor Detail

DataContainerCodecContext

protected DataContainerCodecContext(DataContainerCodecPrototype<T> prototype)

Method Detail

getSchema

@Nonnull
public final T getSchema()

Description copied from interface: BindingTreeNodeCodec

Return schema of node codec context.

Returns:

Object as schema of specific node context

namespace

protected final org.opendaylight.yangtools.yang.common.QNameModule namespace()

factory

protected final NodeCodecContext.CodecContextFactory factory()

getDomPathArgument

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument getDomPathArgument()

Description copied from class: NodeCodecContext

Returns Yang Instance Identifier Path Argument of current node.

Specified by:

getDomPathArgument in class NodeCodecContext<D extends TreeNode>

Returns:

DOM Path Argument of node

yangPathArgumentChild

@Nonnull
public abstract NodeCodecContext<?> yangPathArgumentChild(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument arg)

Returns nested node context using supplied YANG Instance Identifier.

Parameters:

arg - Yang Instance Identifier Argument

Returns:

Context of child

Throws:

IllegalArgumentException - If supplied argument does not represent valid child.

bindingPathArgumentChild

@Nonnull
public DataContainerCodecContext<?,?> bindingPathArgumentChild(@Nonnull
                                                                        TreeArgument<?> arg,
                                                                        List<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> builder)

Returns nested node context using supplied Binding Instance Identifier and adds YANG instance identifiers to supplied list.

Parameters:

arg - Binding Instance Identifier Argument

builder - - mutable instance of list, which is appended by YangInstanceIdentifiers as tree is walked, use null if such side-product is not needed

Returns:

Context of child or null if supplied arg does not represent valid child.

Throws:

IllegalArgumentException - If supplied argument does not represent valid child.

getBindingPathArgument

protected TreeArgument getBindingPathArgument(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument domArg)

Returns de-serialized Binding Path Argument from YANG instance identifier.

Parameters:

domArg - input path argument

Returns:

returns binding path argument

bindingArg

protected final TreeArgument bindingArg()

getBindingClass

@Nonnull
public final Class<D> getBindingClass()

Description copied from interface: BindingTreeNodeCodec

Returns binding class of interface which represents API of current schema node.

Returns:

interface which defines API of binding representation of data.

streamChild

@Nonnull
public abstract <C extends TreeNode> DataContainerCodecContext<C,?> streamChild(@Nonnull
                                                                                         Class<C> childClass)
                                                                                  throws IllegalArgumentException

Returns child context as if it was walked by BindingStreamEventWriter. This means that to enter case, one must issue getChild(ChoiceClass).getChild(CaseClass).

Type Parameters:

C - data type

Parameters:

childClass - input child class

Returns:

Context of child node or null, if supplied class is not subtree child

Throws:

IllegalArgumentException - If supplied child class is not valid in specified context.

possibleStreamChild

public abstract <C extends TreeNode> Optional<DataContainerCodecContext<C,?>> possibleStreamChild(@Nonnull
                                                                                                  Class<C> childClass)

Returns child context as if it was walked by BindingStreamEventWriter. This means that to enter case, one must issue getChild(ChoiceClass).getChild(CaseClass).

Type Parameters:

C - data type

Parameters:

childClass - input child class

Returns:

Context of child or Optional.empty is supplied class is not applicable in context.

toString

public String toString()

Overrides:

toString in class Object

createCachingCodec

@Nonnull
public BindingNormalizedNodeCachingCodec<D> createCachingCodec(@Nonnull
                                                                        com.google.common.collect.ImmutableCollection<Class<? extends TreeNode>> cacheSpecifier)

Description copied from interface: BindingTreeNodeCodec

Returns codec which uses caches serialization / deserialization results.

Caching may introduce performance penalty to serialization / deserialization but may decrease use of heap for repetitive objects.

Parameters:

cacheSpecifier - - set of objects, for which cache may be in place

Returns:

codec which uses cache for serialization / deserialization

createWriter

public BindingStreamEventWriter createWriter(org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

childNonNull

@Nonnull
protected final <V> V childNonNull(@Nullable
                                            V nullable,
                                            org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child,
                                            String message,
                                            Object... args)

childNonNull

@Nonnull
protected final <V> V childNonNull(@Nullable
                                            V nullable,
                                            org.opendaylight.yangtools.yang.common.QName child,
                                            String message,
                                            Object... args)

childNonNull

@Nonnull
protected final <V> V childNonNull(@Nullable
                                            V nullable,
                                            Class<?> childClass,
                                            String message,
                                            Object... args)

eventStreamSerializer

public TreeNodeSerializer eventStreamSerializer()

serialize

@Nonnull
public org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> serialize(@Nonnull
                                                                                              D data)

Description copied from interface: BindingNormalizedNodeCodec

Converts from Binding to Normalized Node representation of data.

Parameters:

data - - Binding representation of data

Returns:

Normalized Node representation of data

writeAsNormalizedNode

public void writeAsNormalizedNode(D data,
                                  org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter writer)

Description copied from interface: BindingTreeNodeCodec

Writes data representing object to supplied stream.

Parameters:

data - - representing object

writer - - supplied stream