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

Interface BindingCodecTree

All Superinterfaces:

BindingDataObjectCodecTreeParent<Empty>

All Known Subinterfaces:

BindingDOMCodecServices

All Known Implementing Classes:

BindingCodecContext, DefaultBindingDOMCodecServices, ForwardingBindingDOMCodecServices, GlobalBindingDOMCodecServices

public interface BindingCodecTree
extends BindingDataObjectCodecTreeParent<Empty>

Navigable tree representing hierarchy of Binding to Normalized Node codecs. This navigable tree is associated to a concrete set of YANG models, represented by SchemaContext and provides access to subtree specific serialization context.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	BindingCodecTree.CodecWithPath<T extends DataObject>	A DTO holding a CommonDataObjectCodecTreeNode and the corresponding YangInstanceIdentifier.

Method Summary

Modifier and Type	Method	Description
<A extends Augmentation<?>> @NonNull BindingAugmentationCodecTreeNode<A>	getAugmentationCodec(DataObjectReference<A> path)	Look up the codec for specified augmentation path.
<T extends DataObject> @NonNull BindingDataObjectCodecTreeNode<T>	getDataObjectCodec(DataObjectReference<T> path)	Look up the codec for specified ordinary DataObject path.
@NonNull BindingIdentityCodec	getIdentityCodec()	Get the BindingIdentityCodec associated with this tree.
@NonNull BindingInstanceIdentifierCodec	getInstanceIdentifierCodec()	Get the BindingInstanceIdentifierCodec associated with this tree.
<T extends DataObject> @NonNull CommonDataObjectCodecTreeNode<T>	getSubtreeCodec(DataObjectReference<T> path)	Look up the codec for specified path.
@Nullable BindingCodecTreeNode	getSubtreeCodec(YangInstanceIdentifier path)	Look up a codec by its YangInstanceIdentifier path.
@Nullable BindingCodecTreeNode	getSubtreeCodec(SchemaNodeIdentifier.Absolute path)
<T extends DataObject> @NonNull BindingCodecTree.CodecWithPath<T>	getSubtreeCodecWithPath(DataObjectReference<T> path)	Look up the codec for specified path, constructing the YangInstanceIdentifier corresponding to it.
<T extends YangData<T>> @NonNull BindingYangDataCodecTreeNode<T>	getYangDataCodec(Class<T> yangDataClass)	Get the BindingYangDataCodecTreeNode corresponding to a particular generated YangData type.
@NonNull BindingYangDataCodecTreeNode<?>	getYangDataCodec(YangDataName yangDataName)	Get the BindingYangDataCodecTreeNode corresponding to a particular YangDataName.

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

getStreamAugmentation, getStreamChild, getStreamDataObject

Method Details

getAugmentationCodec

<A extends Augmentation<?>>
@NonNull BindingAugmentationCodecTreeNode<A> getAugmentationCodec(DataObjectReference<A> path)

Look up the codec for specified augmentation path.

Type Parameters:

A - DataObject type

Parameters:

path - Binding path

Returns:

A BindingAugmentationCodecTreeNode

Throws:

NullPointerException - if path is null

IllegalArgumentException - if the codec cannot be resolved

getDataObjectCodec

<T extends DataObject>
@NonNull BindingDataObjectCodecTreeNode<T> getDataObjectCodec(DataObjectReference<T> path)

Look up the codec for specified ordinary DataObject path.

Type Parameters:

T - DataObject type

Parameters:

path - Binding path

Returns:

A BindingDataObjectCodecTreeNode

Throws:

NullPointerException - if path is null

IllegalArgumentException - if the codec cannot be resolved or refers to an Augmentation

getSubtreeCodecWithPath

<T extends DataObject>
@NonNull BindingCodecTree.CodecWithPath<T> getSubtreeCodecWithPath(DataObjectReference<T> path)

Look up the codec for specified path, constructing the YangInstanceIdentifier corresponding to it.

Type Parameters:

T - DataObject type

Parameters:

path - Binding path

Returns:

A BindingCodecTree.CodecWithPath

Throws:

NullPointerException - if path is null

IllegalArgumentException - if the codec cannot be resolved

getSubtreeCodec

<T extends DataObject>
@NonNull CommonDataObjectCodecTreeNode<T> getSubtreeCodec(DataObjectReference<T> path)

Look up the codec for specified path.

Type Parameters:

T - DataObject type

Parameters:

path - Binding path

Returns:

A BindingDataObjectCodecTreeNode

Throws:

NullPointerException - if path is null

IllegalArgumentException - if the codec cannot be resolved

getSubtreeCodec

@Nullable BindingCodecTreeNode getSubtreeCodec(YangInstanceIdentifier path)

Look up a codec by its YangInstanceIdentifier path.

Parameters:

path - A non-empty YangInstanceIdentifier

Returns:

A BindingCodecTreeNode

Throws:

NullPointerException - if path is null

IllegalArgumentException - if path is empty

getSubtreeCodec

@Nullable BindingCodecTreeNode getSubtreeCodec(SchemaNodeIdentifier.Absolute path)

getIdentityCodec

@NonNull BindingIdentityCodec getIdentityCodec()

Get the BindingIdentityCodec associated with this tree.

Returns:

A BindingIdentityCodec instance.

getInstanceIdentifierCodec

@NonNull BindingInstanceIdentifierCodec getInstanceIdentifierCodec()

Get the BindingInstanceIdentifierCodec associated with this tree.

Returns:

A BindingInstanceIdentifierCodec instance.

getYangDataCodec

<T extends YangData<T>>
@NonNull BindingYangDataCodecTreeNode<T> getYangDataCodec(Class<T> yangDataClass)

Get the BindingYangDataCodecTreeNode corresponding to a particular generated YangData type.

Type Parameters:

T - YangData type

Parameters:

yangDataClass - Class object of YangData type

Returns:

A BindingYangDataCodecTreeNode

Throws:

NullPointerException - if yangDataClass is null

IllegalArgumentException - if the specified type is not known

getYangDataCodec

@NonNull BindingYangDataCodecTreeNode<?> getYangDataCodec(YangDataName yangDataName)

Get the BindingYangDataCodecTreeNode corresponding to a particular YangDataName.

Parameters:

yangDataName - a YangDataName

Returns:

A BindingYangDataCodecTreeNode

Throws:

NullPointerException - if yangDataName is null

IllegalArgumentException - if the specified name is not known