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

Interface BindingCodecTreeNode<T extends DataObject>

All Superinterfaces:

BindingCodecTreeNode<T>, BindingNormalizedNodeCodec<T>

@Beta
public interface BindingCodecTreeNode<T extends DataObject>
extends BindingNormalizedNodeCodec<T>, BindingCodecTreeNode<T>

Subtree codec specific to model subtree between Java Binding and NormalizedNode.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BindingCodecTreeNode.ChildAddressabilitySummary Enumeration of possible addressability attribute of all children.

Method Summary

Modifier and Type	Method and Description
BindingCodecTreeNode<?>	bindingPathArgumentChild(InstanceIdentifier.PathArgument 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 DataObject>> 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.
InstanceIdentifier.PathArgument	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.
BindingCodecTreeNode.ChildAddressabilitySummary	getChildAddressabilitySummary() Return a summary of addressability of potential children.
Object	getSchema()
<E extends DataObject> com.google.common.base.Optional<? extends BindingCodecTreeNode<E>>	possibleStreamChild(Class<E> childClass) Returns child context as if it was walked by BindingStreamEventWriter.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument	serializePathArgument(InstanceIdentifier.PathArgument arg) Serializes path argument for current node.
<E extends DataObject> BindingCodecTreeNode<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)
BindingCodecTreeNode<?>	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.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. The result is same as invoking DataContainer.getImplementedInterface() on instance of data.

Specified by:

getBindingClass in interface BindingCodecTreeNode<T extends DataObject>

Returns:

interface which defines API of binding representation of data.

streamChild

@Nonnull
<E extends DataObject> BindingCodecTreeNode<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).

Specified by:

streamChild in interface BindingCodecTreeNode<T extends DataObject>

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 DataObject> com.google.common.base.Optional<? extends BindingCodecTreeNode<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 BindingCodecTreeNode even if augmentation interface containing same data was supplied and does not represent augmentation of this node.

Specified by:

possibleStreamChild in interface BindingCodecTreeNode<T extends DataObject>

Parameters:

childClass -

Returns:

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

yangPathArgumentChild

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

Returns nested node context using supplied YANG Instance Identifier

Specified by:

yangPathArgumentChild in interface BindingCodecTreeNode<T extends DataObject>

Parameters:

child - Yang Instance Identifier Argument

Returns:

Context of child

Throws:

IllegalArgumentException - If supplied argument does not represent valid child.

bindingPathArgumentChild

@Nonnull
BindingCodecTreeNode<?> bindingPathArgumentChild(@Nonnull
                                                          InstanceIdentifier.PathArgument 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.

Specified by:

bindingPathArgumentChild in interface BindingCodecTreeNode<T extends DataObject>

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

Specified by:

createCachingCodec in interface BindingCodecTreeNode<T extends DataObject>

Parameters:

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

Returns:

Codec whihc uses cache for serialization / deserialization.

writeAsNormalizedNode

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

Specified by:

writeAsNormalizedNode in interface BindingCodecTreeNode<T extends DataObject>

serializePathArgument

@Beta
 @Nullable
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument serializePathArgument(@Nullable
                                                                                                                    InstanceIdentifier.PathArgument arg)

Serializes path argument for current node.

Specified by:

serializePathArgument in interface BindingCodecTreeNode<T extends DataObject>

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

@Beta
 @Nullable
InstanceIdentifier.PathArgument deserializePathArgument(@Nullable
                                                                         org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument arg)

Deserializes path argument for current node.

Specified by:

deserializePathArgument in interface BindingCodecTreeNode<T extends DataObject>

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

Object getSchema()

Specified by:

getSchema in interface BindingCodecTreeNode<T extends DataObject>

getChildAddressabilitySummary

@Nonnull
BindingCodecTreeNode.ChildAddressabilitySummary getChildAddressabilitySummary()

Return a summary of addressability of potential children. Binding specification does not allow all DOM tree elements to be directly addressed, which means some recursive tree operations, like data tree changes do not have a one-to-one mapping from DOM to binding in all cases. This method provides an optimization hint to guide translation of data structures, allowing for fast paths when all children are known to either be addressable or non-addressable.

Returns:

Summary children addressability.