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

Class ChoiceNodeCodecContext<D extends TreeNode>

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,org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode>

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

Type Parameters:

D - - type of tree node

All Implemented Interfaces:

BindingNormalizedNodeCodec<D>, BindingTreeNodeCodec<D>

@Beta
public class ChoiceNodeCodecContext<D extends TreeNode>
extends DataContainerCodecContext<D,org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode>

Context for prototype of choice node codec.

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

Constructor and Description
ChoiceNodeCodecContext(DataContainerCodecPrototype<org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode> prototype) Prepare context for choice node from prototype and all case children of choice class.

Method Summary

Modifier and Type	Method and Description
D	deserialize(org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data) Converts from Normalized Node to Binding representation of data.
protected Object	deserializeObject(org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)
TreeArgument<?>	deserializePathArgument(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument arg) Deserializes path argument for current node.
DataContainerCodecContext<?,?>	getCaseByChildClass(Class<? extends TreeNode> type)
Map<Class<?>,DataContainerCodecPrototype<?>>	getClassCaseChildren() Gets the map of case class and prototype for TreeNodeCodecContext to catch choice/cases' data child by class.
Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument,DataContainerCodecPrototype<?>>	getYangCaseChildren() Gets the map of case path argument and prototype for TreeNodeCodecContext to catch choice/cases' data child by class.
<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.YangInstanceIdentifier.PathArgument	serializePathArgument(TreeArgument<?> arg) Serializes path argument for current node.
<C extends TreeNode> DataContainerCodecContext<C,?>	streamChild(Class<C> childClass) Returns child context as if it was walked by BindingStreamEventWriter.
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.DataContainerCodecContext

bindingArg, bindingPathArgumentChild, childNonNull, childNonNull, childNonNull, createCachingCodec, createWriter, eventStreamSerializer, factory, getBindingClass, getBindingPathArgument, getDomPathArgument, getSchema, namespace, serialize, toString, writeAsNormalizedNode

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

addYangPathArgument

Methods inherited from class java.lang.Object

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

Constructor Detail

ChoiceNodeCodecContext

public ChoiceNodeCodecContext(DataContainerCodecPrototype<org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode> prototype)

Prepare context for choice node from prototype and all case children of choice class.

Parameters:

prototype - - codec prototype of choice node

Method Detail

streamChild

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

Description copied from class: DataContainerCodecContext

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

Specified by:

streamChild in interface BindingTreeNodeCodec<D extends TreeNode>

Specified by:

streamChild in class DataContainerCodecContext<D extends TreeNode,org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode>

Type Parameters:

C - data type

Parameters:

childClass - input child class

Returns:

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

possibleStreamChild

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

Description copied from class: DataContainerCodecContext

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

Specified by:

possibleStreamChild in interface BindingTreeNodeCodec<D extends TreeNode>

Specified by:

possibleStreamChild in class DataContainerCodecContext<D extends TreeNode,org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode>

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.

getClassCaseChildren

public Map<Class<?>,DataContainerCodecPrototype<?>> getClassCaseChildren()

Gets the map of case class and prototype for TreeNodeCodecContext to catch choice/cases' data child by class.

Returns:

the map of case class and prototype

getYangCaseChildren

public Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument,DataContainerCodecPrototype<?>> getYangCaseChildren()

Gets the map of case path argument and prototype for TreeNodeCodecContext to catch choice/cases' data child by class.

Returns:

the the map of case path and prototype

getCaseByChildClass

public DataContainerCodecContext<?,?> getCaseByChildClass(@Nonnull
                                                          Class<? extends TreeNode> type)

yangPathArgumentChild

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

Description copied from class: DataContainerCodecContext

Returns nested node context using supplied YANG Instance Identifier.

Specified by:

yangPathArgumentChild in interface BindingTreeNodeCodec<D extends TreeNode>

Specified by:

yangPathArgumentChild in class DataContainerCodecContext<D extends TreeNode,org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode>

Parameters:

arg - Yang Instance Identifier Argument

Returns:

Context of child

deserialize

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

Description copied from interface: BindingNormalizedNodeCodec

Converts from Normalized Node to Binding representation of data.

Parameters:

data - - Normalized Node representation of data

Returns:

Binding representation of data

deserializeObject

protected Object deserializeObject(org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)

Specified by:

deserializeObject in class NodeCodecContext<D extends TreeNode>

deserializePathArgument

@Nonnull
public TreeArgument<?> deserializePathArgument(@Nonnull
                                                        org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument arg)

Description copied from interface: BindingTreeNodeCodec

Deserializes path argument for current node.

Parameters:

arg - - Yang Path Argument, may be null if Yang Instance Identifier does not have representation for current node (e.g. case)

Returns:

Binding Path Argument, may be null if Binding Instance Identifier does not have representation for current node (e.g. choice or case)

serializePathArgument

@Nonnull
public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument serializePathArgument(@Nonnull
                                                                                                                   TreeArgument<?> arg)

Description copied from interface: BindingTreeNodeCodec

Serializes path argument for current node.

Parameters:

arg - - Binding Path Argument, may be null if Binding Instance Identifier does not have representation for current node (e.g. choice or case)

Returns:

Yang Path Argument, may be null if Yang Instance Identifier does not have representation for current node (e.g. case).