org.opendaylight.mdsal.binding.javav2.dom.codec.api

Interface BindingTreeNodeCodec<T extends TreeNode>

Type Parameters:

T - - Binding representation of data

All Superinterfaces:

BindingNormalizedNodeCodec<T>

All Known Implementing Classes:

AnyxmlNodeCodecContext, AugmentationNodeContext, CaseNodeCodecContext, ChoiceNodeCodecContext, ContainerNodeCodecContext, DataContainerCodecContext, KeyedListNodeCodecContext, LeafNodeCodecContext, ListNodeCodecContext, NodeCodecContext, NotificationCodecContext, SchemaRootCodecContext, TreeNodeCodecContext

@Beta
public interface BindingTreeNodeCodec<T extends TreeNode>
extends BindingNormalizedNodeCodec<T>

Specific subtree codec to model subtree between Java Binding and DOM.

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<T>	createCachingCodec(com.google.common.collect.ImmutableCollection<Class<? extends TreeNode>> cacheSpecifier) Returns codec which uses caches serialization / deserialization results.
TreeArgument<?>	deserializePathArgument(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument arg) Deserializes path argument for current node.
Class<T>	getBindingClass() Returns binding class of interface which represents API of current schema node.
Object	getSchema() Return schema of node codec context.
<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.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(T 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 interface org.opendaylight.mdsal.binding.javav2.dom.codec.api.BindingNormalizedNodeCodec

deserialize, serialize

Method Detail

getBindingClass

@Nonnull
Class<T> getBindingClass()

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

Returns:

interface which defines API of binding representation of data.

streamChild

@Nonnull
<E extends TreeNode> BindingTreeNodeCodec<E> streamChild(@Nonnull
                                                                  Class<E> 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:

E - data type

Parameters:

childClass - - child class by Biding Stream navigation

Returns:

context of child

Throws:

IllegalArgumentException - - if supplied child class is not valid in specified context

possibleStreamChild

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

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

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
BindingTreeNodeCodec<?> yangPathArgumentChild(@Nonnull
                                                       org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child)

Returns nested node context using supplied YANG Instance Identifier.

Parameters:

child - - Yang Instance Identifier Argument

Returns:

context of child

Throws:

IllegalArgumentException - - if supplied argument does not represent valid child

bindingPathArgumentChild

@Nonnull
BindingTreeNodeCodec<?> bindingPathArgumentChild(@Nonnull
                                                          TreeArgument<?> arg,
                                                          @Nullable
                                                          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

Throws:

IllegalArgumentException - - if supplied argument does not represent valid child.

createCachingCodec

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

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

writeAsNormalizedNode

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

Writes data representing object to supplied stream.

Parameters:

data - - representing object

writer - - supplied stream

serializePathArgument

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

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

Throws:

IllegalArgumentException - - if supplied arg is not valid.

deserializePathArgument

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

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)

Throws:

IllegalArgumentException - - if supplied arg is not valid.

getSchema

@Nonnull
Object getSchema()

Return schema of node codec context.

Returns:

Object as schema of specific node context