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

Class AnyxmlNodeCodecContext<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.AnyxmlNodeCodecContext<D>

All Implemented Interfaces:

BindingNormalizedNodeCodec<D>, BindingTreeNodeCodec<D>

@Beta
public final class AnyxmlNodeCodecContext<D extends TreeNode>
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

Method Summary

Modifier and Type	Method and Description
BindingTreeNodeCodec<?>	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.
BindingNormalizedNodeCachingCodec<D>	createCachingCodec(com.google.common.collect.ImmutableCollection<Class<? extends TreeNode>> cacheSpecifier) Returns codec which uses caches serialization / deserialization results.
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.
NodeCodecContext<?>	get()
Class<D>	getBindingClass() Returns binding class of interface which represents API of current schema node.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument	getDomPathArgument() Returns Yang Instance Identifier Path Argument of current node.
Method	getGetter()
org.opendaylight.yangtools.yang.model.api.DataSchemaNode	getSchema() Return schema of node codec context.
org.opendaylight.yangtools.concepts.Codec<Object,Object>	getValueCodec()
<E extends TreeNode> Optional<? extends BindingTreeNodeCodec<E>>	possibleStreamChild(Class<E> 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.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument	serializePathArgument(TreeArgument arg) Serializes path argument for current node.
<E extends TreeNode> BindingTreeNodeCodec<E>	streamChild(Class<E> childClass) Returns child context as if it was walked by BindingStreamEventWriter.
void	writeAsNormalizedNode(D data, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter writer) Writes data representing object to supplied stream.
BindingTreeNodeCodec<?>	yangPathArgumentChild(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child) 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

Methods inherited from class java.lang.Object

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

Method Detail

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

getValueCodec

public org.opendaylight.yangtools.concepts.Codec<Object,Object> getValueCodec()

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.

Specified by:

deserialize in interface BindingNormalizedNodeCodec<D extends TreeNode>

Parameters:

normalizedNode - - Normalized Node representation of data

Returns:

Binding representation of data

get

@Nonnull
public NodeCodecContext<?> get()

getGetter

public Method getGetter()

bindingPathArgumentChild

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

Description copied from interface: BindingTreeNodeCodec

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

Specified by:

bindingPathArgumentChild in interface BindingTreeNodeCodec<D extends TreeNode>

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

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.

Specified by:

createCachingCodec in interface BindingTreeNodeCodec<D extends TreeNode>

Parameters:

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

Returns:

codec which uses cache for serialization / deserialization

getBindingClass

@Nonnull
public Class<D> getBindingClass()

Description copied from interface: BindingTreeNodeCodec

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

Specified by:

getBindingClass in interface BindingTreeNodeCodec<D extends TreeNode>

Returns:

interface which defines API of binding representation of data.

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.

Specified by:

serialize in interface BindingNormalizedNodeCodec<D extends TreeNode>

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.

Specified by:

writeAsNormalizedNode in interface BindingTreeNodeCodec<D extends TreeNode>

Parameters:

data - - representing object

writer - - supplied stream

streamChild

@Nonnull
public <E extends TreeNode> BindingTreeNodeCodec<E> streamChild(@Nonnull
                                                                         Class<E> childClass)

Description copied from interface: BindingTreeNodeCodec

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>

Type Parameters:

E - data type

Parameters:

childClass - - child class by Biding Stream navigation

Returns:

context of child

possibleStreamChild

public <E extends TreeNode> Optional<? extends BindingTreeNodeCodec<E>> possibleStreamChild(@Nonnull
                                                                                            Class<E> childClass)

Description copied from interface: BindingTreeNodeCodec

Returns child context as if it was walked by BindingStreamEventWriter. This means that to enter case, one must issue getChild(ChoiceClass).getChild(CaseClass). This method differs from BindingTreeNodeCodec.streamChild(Class), that is less stricter for interfaces representing augmentation and cases, that may return BindingTreeNodeCodec even if augmentation interface containing same data was supplied and does not represent augmentation of this node.

Specified by:

possibleStreamChild in interface BindingTreeNodeCodec<D extends TreeNode>

Type Parameters:

E - data type

Parameters:

childClass - - child class by Binding Stream navigation

Returns:

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

yangPathArgumentChild

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

Description copied from interface: BindingTreeNodeCodec

Returns nested node context using supplied YANG Instance Identifier.

Specified by:

yangPathArgumentChild in interface BindingTreeNodeCodec<D extends TreeNode>

Parameters:

child - - Yang Instance Identifier Argument

Returns:

context of child

deserializeObject

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

Specified by:

deserializeObject in class NodeCodecContext<D extends TreeNode>

deserializePathArgument

public TreeArgument deserializePathArgument(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument arg)

Description copied from interface: BindingTreeNodeCodec

Deserializes path argument for current node.

Specified by:

deserializePathArgument in interface BindingTreeNodeCodec<D extends TreeNode>

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

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument serializePathArgument(TreeArgument arg)

Description copied from interface: BindingTreeNodeCodec

Serializes path argument for current node.

Specified by:

serializePathArgument in interface BindingTreeNodeCodec<D extends TreeNode>

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

getSchema

@Nonnull
public org.opendaylight.yangtools.yang.model.api.DataSchemaNode getSchema()

Description copied from interface: BindingTreeNodeCodec

Return schema of node codec context.

Specified by:

getSchema in interface BindingTreeNodeCodec<D extends TreeNode>

Returns:

Object as schema of specific node context