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

Interface BindingCodecTreeNode<T extends DataObject>

All Superinterfaces:

BindingNormalizedNodeCodec<T>

@Beta
public interface BindingCodecTreeNode<T extends DataObject>
extends BindingNormalizedNodeCodec<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
@NonNull BindingCodecTreeNode<?>	bindingPathArgumentChild(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 the supplied list.
@NonNull BindingNormalizedNodeCachingCodec<T>	createCachingCodec(@NonNull com.google.common.collect.ImmutableCollection<Class<? extends DataObject>> cacheSpecifier) Returns codec which uses caches serialization / deserialization results.
InstanceIdentifier.PathArgument	deserializePathArgument(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument arg) Deserializes path argument for current node.
@NonNull Class<T>	getBindingClass() Returns binding class of interface which represents API of current schema node.
@NonNull BindingCodecTreeNode.ChildAddressabilitySummary	getChildAddressabilitySummary() Return a summary of addressability of potential children.
@NonNull org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus	getSchema() Return the schema node associated with this node.
<E extends DataObject> Optional<? extends BindingCodecTreeNode<E>>	possibleStreamChild(@NonNull 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> @NonNull BindingCodecTreeNode<E>	streamChild(@NonNull 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)
@NonNull 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.

Returns:

interface which defines API of binding representation of data.

streamChild

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

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

Parameters:

childClass -

Returns:

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

yangPathArgumentChild

@NonNull BindingCodecTreeNode<?> yangPathArgumentChild(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 BindingCodecTreeNode<?> bindingPathArgumentChild(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 the 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 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.

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)

serializePathArgument

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

@Beta
InstanceIdentifier.PathArgument deserializePathArgument(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 org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus getSchema()

Return the schema node associated with this node.

Returns:

A schema node.

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.