Package org.opendaylight.yangtools.binding.data.codec.impl

Class DataObjectCodecContext<D extends DataObject,T extends CompositeRuntimeType>

java.lang.Object

org.opendaylight.yangtools.binding.data.codec.impl.CommonDataObjectCodecContext<D,T>

org.opendaylight.yangtools.binding.data.codec.impl.DataObjectCodecContext<D,T>

All Implemented Interfaces:

BindingCodecTreeNode, BindingDataContainerCodecTreeNode<D>, BindingDataContainerWriter<D>, BindingDataObjectCodecTreeNode<D>, BindingDataObjectCodecTreeParent<Empty>, BindingNormalizedNodeCodec<D>, BindingObjectCodecTreeNode, CommonDataObjectCodecTreeNode<D>

@Beta
public abstract sealed class DataObjectCodecContext<D extends DataObject,T extends CompositeRuntimeType>
extends CommonDataObjectCodecContext<D,T>
implements BindingDataObjectCodecTreeNode<D>

This class is an implementation detail. It is public only due to technical reasons and may change at any time.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.binding.data.codec.api.BindingDataContainerCodecTreeNode

BindingDataContainerCodecTreeNode.ChildAddressabilitySummary

Method Summary

Modifier and Type	Method	Description
protected final <V> @NonNull V	childNonNull(@Nullable V nullable, Class<?> childClass, String message, Object... args)
protected final <V> @NonNull V	childNonNull(@Nullable V nullable, QName child, String message, Object... args)
protected final <V> @NonNull V	childNonNull(@Nullable V nullable, YangInstanceIdentifier.PathArgument child, String message, Object... args)
final BindingNormalizedNodeCachingCodec<D>	createCachingCodec(ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier)	Returns codec which uses caches serialization / deserialization results.
DataObjectStep<?>	deserializePathArgument(YangInstanceIdentifier.PathArgument arg)	Deserializes YangInstanceIdentifier.PathArgument for current node.
final Class<D>	getBindingClass()	Returns binding class of interface which represents API of current schema node.
final BindingDataContainerCodecTreeNode.ChildAddressabilitySummary	getChildAddressabilitySummary()	Return a summary of addressability of potential children.
final <C extends DataObject> org.opendaylight.yangtools.binding.data.codec.impl.DataContainerCodecContext<C,?,?>	getStreamChild(Class<C> childClass)	Returns child context as if it was walked by BindingStreamEventWriter.
final NormalizedNode	serialize(D data)	Converts from Binding to Normalized Node representation of data.
YangInstanceIdentifier.PathArgument	serializePathArgument(DataObjectStep<?> step)	Serializes the instance identifier step for current node.
final <C extends DataObject> org.opendaylight.yangtools.binding.data.codec.impl.DataContainerCodecContext<C,?,?>	streamChild(Class<C> childClass)	Returns child context as if it was walked by BindingStreamEventWriter.
String	toString()
final void	writeTo(NormalizedNodeStreamWriter writer, D dataContainer)	Write a particular object to target writer.
org.opendaylight.yangtools.binding.data.codec.impl.CodecContext	yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg)	Returns nested node context using supplied YangInstanceIdentifier.PathArgument.

Methods inherited from class org.opendaylight.yangtools.binding.data.codec.impl.CommonDataObjectCodecContext

bindingArg, bindingPathArgumentChild, getBindingPathArgument, getSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeNode

getSchema

Methods inherited from interface org.opendaylight.yangtools.binding.data.codec.api.BindingDataContainerCodecTreeNode

bindingPathArgumentChild, getBindingClass, getChildAddressabilitySummary, streamAugmentation, streamChild, streamDataObject, yangPathArgumentChild

Methods inherited from interface org.opendaylight.yangtools.binding.data.codec.api.BindingDataObjectCodecTreeParent

getStreamAugmentation, getStreamChild, getStreamDataObject

Methods inherited from interface org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeCodec

deserialize

Method Details

deserializePathArgument

public DataObjectStep<?> deserializePathArgument(YangInstanceIdentifier.PathArgument arg)

Description copied from interface: CommonDataObjectCodecTreeNode

Deserializes YangInstanceIdentifier.PathArgument for current node.

Specified by:

deserializePathArgument in interface CommonDataObjectCodecTreeNode<D extends DataObject>

Parameters:

arg - a YangInstanceIdentifier.PathArgument, may be null if YangInstanceIdentifier does not have a representation for current node (e.g. case).

Returns:

DataObjectStep, may be null if DataObjectReference does not have a representation for current node (e.g. choice or case).

serializePathArgument

public YangInstanceIdentifier.PathArgument serializePathArgument(DataObjectStep<?> step)

Description copied from interface: CommonDataObjectCodecTreeNode

Serializes the instance identifier step for current node.

Specified by:

serializePathArgument in interface CommonDataObjectCodecTreeNode<D extends DataObject>

Parameters:

step - DataObjectStep, may be null if DataObjectReference does not have a representation for current node (e.g. choice or case).

Returns:

YangInstanceIdentifier.PathArgument, may be null if YangInstanceIdentifier does not have representation for current node (e.g. case).

serialize

public final NormalizedNode serialize(D data)

Description copied from interface: BindingNormalizedNodeCodec

Converts from Binding to Normalized Node representation of data.

Specified by:

serialize in interface BindingNormalizedNodeCodec<D extends DataObject>

Parameters:

data - Binding representation of data

Returns:

Normalized Node representation of data

writeTo

public final void writeTo(NormalizedNodeStreamWriter writer,
 D dataContainer)
                   throws IOException

Description copied from interface: BindingDataContainerWriter

Write a particular object to target writer.

Specified by:

writeTo in interface BindingDataContainerWriter<D extends DataObject>

Parameters:

writer - target writer

dataContainer - DataContainer to write

Throws:

IOException - when an I/O error occurs

createCachingCodec

public final BindingNormalizedNodeCachingCodec<D> createCachingCodec(ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier)

Description copied from interface: BindingDataObjectCodecTreeNode

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 BindingDataObjectCodecTreeNode<D extends DataObject>

Parameters:

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

Returns:

Codec which uses cache for serialization / deserialization.

getBindingClass

public final Class<D> getBindingClass()

Description copied from interface: BindingDataContainerCodecTreeNode

Returns binding class of interface which represents API of current schema node. The result is same as invoking BindingContract.implementedInterface() on instance of data.

Specified by:

getBindingClass in interface BindingDataContainerCodecTreeNode<D extends DataContainer>

Specified by:

getBindingClass in interface BindingObjectCodecTreeNode

Returns:

interface which defines API of binding representation of data.

getChildAddressabilitySummary

public final BindingDataContainerCodecTreeNode.ChildAddressabilitySummary getChildAddressabilitySummary()

Description copied from interface: BindingDataContainerCodecTreeNode

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.

Specified by:

getChildAddressabilitySummary in interface BindingDataContainerCodecTreeNode<D extends DataContainer>

Returns:

Summary children addressability.

yangPathArgumentChild

public org.opendaylight.yangtools.binding.data.codec.impl.CodecContext yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg)

Description copied from interface: BindingDataContainerCodecTreeNode

Returns nested node context using supplied YangInstanceIdentifier.PathArgument.

Specified by:

yangPathArgumentChild in interface BindingDataContainerCodecTreeNode<D extends DataContainer>

Parameters:

arg - a YangInstanceIdentifier.PathArgument

Returns:

Context of child

getStreamChild

public final <C extends DataObject>
org.opendaylight.yangtools.binding.data.codec.impl.DataContainerCodecContext<C,?,?> getStreamChild(Class<C> childClass)

Description copied from interface: BindingDataObjectCodecTreeParent

Returns child context as if it was walked by BindingStreamEventWriter. This means that to enter case, one must issue getStreamChild(ChoiceClass).getStreamChild(CaseClass).

Specified by:

getStreamChild in interface BindingDataObjectCodecTreeParent<D extends DataContainer>

Type Parameters:

C - Stream child DataObject type

Parameters:

childClass - Child class by Binding Stream navigation

Returns:

Context of child

streamChild

public final <C extends DataObject>
org.opendaylight.yangtools.binding.data.codec.impl.DataContainerCodecContext<C,?,?> streamChild(Class<C> childClass)

Description copied from interface: BindingDataContainerCodecTreeNode

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 BindingDataObjectCodecTreeParent.getStreamChild(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.

Specified by:

streamChild in interface BindingDataContainerCodecTreeNode<D extends DataContainer>

Parameters:

childClass - Child class by Binding Stream navigation

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

childNonNull

protected final <V> @NonNull V childNonNull(@Nullable V nullable,
 YangInstanceIdentifier.PathArgument child,
 String message,
 Object... args)

childNonNull

protected final <V> @NonNull V childNonNull(@Nullable V nullable,
 QName child,
 String message,
 Object... args)

childNonNull

protected final <V> @NonNull V childNonNull(@Nullable V nullable,
 Class<?> childClass,
 String message,
 Object... args)