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

Interface CommonDataObjectCodecTreeNode<T extends DataObject>

Type Parameters:

T - DataObject type

All Superinterfaces:

BindingCodecTreeNode, BindingDataContainerCodecTreeNode<T>, BindingDataObjectCodecTreeParent<Empty>, BindingObjectCodecTreeNode

All Known Subinterfaces:

BindingAugmentationCodecTreeNode<T>, BindingDataObjectCodecTreeNode<T>

All Known Implementing Classes:

CommonDataObjectCodecContext, DataObjectCodecContext

public interface CommonDataObjectCodecTreeNode<T extends DataObject>
extends BindingDataContainerCodecTreeNode<T>

Common interface shared between BindingDataObjectCodecTreeNode and BindingAugmentationCodecTreeNode. This interface should never be implemented on its own.

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
@Nullable DataObjectStep<?>	deserializePathArgument(@Nullable YangInstanceIdentifier.PathArgument arg)	Deserializes YangInstanceIdentifier.PathArgument for current node.
@Nullable YangInstanceIdentifier.PathArgument	serializePathArgument(@Nullable DataObjectStep<?> step)	Serializes the instance identifier step for current node.

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

Method Details

serializePathArgument

@Beta
@Nullable YangInstanceIdentifier.PathArgument serializePathArgument(@Nullable DataObjectStep<?> step)

Serializes the instance identifier step for current node.

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

Throws:

IllegalArgumentException - If supplied arg is not valid.

deserializePathArgument

@Beta
@Nullable DataObjectStep<?> deserializePathArgument(@Nullable YangInstanceIdentifier.PathArgument arg)

Deserializes YangInstanceIdentifier.PathArgument for current node.

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

Throws:

IllegalArgumentException - If supplied arg is not valid.