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

Class SchemaRootCodecContext<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.SchemaContext>

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

Type Parameters:

D - - tree node type

All Implemented Interfaces:

BindingNormalizedNodeCodec<D>, BindingTreeNodeCodec<D>

@Beta
public final class SchemaRootCodecContext<D extends TreeNode>
extends DataContainerCodecContext<D,org.opendaylight.yangtools.yang.model.api.SchemaContext>

Creates RootNode from supplied CodecContextFactory and make operations with.

Nested Class Summary

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

NodeCodecContext.CodecContextFactory

Method Summary

Modifier and Type	Method and Description
static SchemaRootCodecContext<?>	create(NodeCodecContext.CodecContextFactory factory) Creates RootNode from supplied CodecContextFactory.
D	deserialize(org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode) 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.
NotificationCodecContext<?>	getNotification(Class<? extends Notification> notification) Get notification as binding object of binding class.
NotificationCodecContext<?>	getNotification(org.opendaylight.yangtools.yang.model.api.SchemaPath notification) Get notification as binding object according to schema path of notification.
ContainerNodeCodecContext<?>	getOperation(Class<? extends Instantiable<?>> operationInputOrOutput) Get operation as binding object of binding class.
OperationInputCodec<?>	getOperation(org.opendaylight.yangtools.yang.model.api.SchemaPath operation) Get operation input as binding object according to schema path of operation.
<E extends TreeNode> Optional<DataContainerCodecContext<E,?>>	possibleStreamChild(Class<E> 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.
DataContainerCodecContext<?,?>	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

Method Detail

create

public static SchemaRootCodecContext<?> create(NodeCodecContext.CodecContextFactory factory)

Creates RootNode from supplied CodecContextFactory.

Parameters:

factory - - CodecContextFactory

Returns:

schema root node

streamChild

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

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.SchemaContext>

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 <E extends TreeNode> Optional<DataContainerCodecContext<E,?>> possibleStreamChild(@Nonnull
                                                                                         Class<E> 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.SchemaContext>

Type Parameters:

E - data type

Parameters:

childClass - input child class

Returns:

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

yangPathArgumentChild

@Nonnull
public DataContainerCodecContext<?,?> 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.SchemaContext>

Parameters:

arg - Yang Instance Identifier Argument

Returns:

Context of child

deserialize

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

Description copied from interface: BindingNormalizedNodeCodec

Converts from Normalized Node to Binding representation of data.

Parameters:

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

@Nullable
public TreeArgument<?> deserializePathArgument(@Nullable
                                                         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

@Nullable
public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument serializePathArgument(@Nullable
                                                                                                                    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).

getOperation

public ContainerNodeCodecContext<?> getOperation(Class<? extends Instantiable<?>> operationInputOrOutput)

Get operation as binding object of binding class.

Parameters:

operationInputOrOutput - - binding class

Returns:

container node codec context of operation

getOperation

public OperationInputCodec<?> getOperation(org.opendaylight.yangtools.yang.model.api.SchemaPath operation)

Get operation input as binding object according to schema path of operation.

Parameters:

operation - - schema path of operation

Returns:

operation input codec of operation

getNotification

public NotificationCodecContext<?> getNotification(Class<? extends Notification> notification)

Get notification as binding object of binding class.

Parameters:

notification - - binding class

Returns:

notification codec context of notification

getNotification

public NotificationCodecContext<?> getNotification(org.opendaylight.yangtools.yang.model.api.SchemaPath notification)

Get notification as binding object according to schema path of notification.

Parameters:

notification - - schema path of notification

Returns:

notification codec context of notification