Package org.opendaylight.yangtools.binding.data.codec.api
package org.opendaylight.yangtools.binding.data.codec.api
API elements of a codec capable translating YANG-modeled data between its
BindingObject
s and
NormalizedData
representations. The central piece is
BindingDataCodec
, which is a service typically provided by dependency injection.
ServiceLoader
is provided for simple environments.-
ClassDescriptionBindingAugmentationCodecTreeNode<T extends Augmentation<?>>BindingChoiceCodecTreeNode<C extends ChoiceIn<?>>A
BindingDataContainerCodecTreeNode
corresponding to a baseChoiceIn
.Navigable tree representing hierarchy of Binding to Normalized Node codecs.BindingCodecTree.CodecWithPath<T extends DataObject>A DTO holding aCommonDataObjectCodecTreeNode
and the correspondingYangInstanceIdentifier
.Subtree codec specific to model subtree between Java Binding and NormalizedNode.Binding/NormalizedNode codec services.BindingDataContainerCodecTreeNode<T extends DataContainer>ABindingObjectCodecTreeNode
which corresponds to aDataContainer
construct.Enumeration of possible addressability attribute of all children.BindingDataContainerWriter<T extends DataContainer>An entity capable of sourcingNormalizedNodeStreamWriter
events from aDataContainer
.BindingDataObjectCodecTreeNode<T extends DataObject>Common interface for entities which can supply aBindingDataObjectCodecTreeNode
based on Binding DataObject class instance.A codec capable of translatingidentity
values between their YANG (QName) and Binding (Class) representation.BindingLazyContainerNode<T extends DataObject>AContainerNode
backed by a bindingDataObject
, with lazy instantiation of the ContainerNode view.BindingNormalizedNodeCachingCodec<T extends BindingObject>Caching variant of Binding to Normalized Node codec.BindingNormalizedNodeCodec<T extends BindingObject>Codec providing serialization and deserializiation between Binding and NormalizedNode representation of data.Serialization service, which provides two-way serialization between Java Binding Data representation and NormalizedNode representation.Factory forBindingStreamEventWriter
, which provides stream writers which translates data and delegates calls toNormalizedNodeStreamWriter
.BindingOpaqueObjectCodecTreeNode<T extends OpaqueObject<T>>Event Stream Writer for Binding Representation.BindingTypeObjectCodecTreeNode<T extends TypeObject>BindingYangDataCodec<T extends YangData<T>>A codec capable of translating RFC8040yang-data
values between theirNormalizedYangData
andYangData
representation.BindingYangDataCodecTreeNode<T extends YangData<T>>CommonDataObjectCodecTreeNode<T extends DataObject>Common interface shared betweenBindingDataObjectCodecTreeNode
andBindingAugmentationCodecTreeNode
.Thrown where incorrect nesting of data structures was detected and was caused by user.Thrown when user schema for supplied binding class is available in present schema context, but binding class itself is not known to codecs because backing class loading strategy did not provided it.Thrown when codec was used with data which are not modeled and available in schema used by codec.Thrown when Java Binding class was used in data for which codec does not have schema.