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

Interface BindingAugmentationCodecTreeNode<T extends Augmentation<?>>

All Superinterfaces:

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

@Beta
public interface BindingAugmentationCodecTreeNode<T extends Augmentation<?>>
extends CommonDataObjectCodecTreeNode<T>

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
@NonNull ImmutableSet<YangInstanceIdentifier.NodeIdentifier>	childPathArguments()	Returns the YangInstanceIdentifier.NodeIdentifiers of items contained in this Augmentation.
@Nullable T	filterFrom(@NonNull DataContainerNode parentData)	Return an Augmentation instance backed by specified parent data.
default @Nullable T	filterFrom(@NonNull NormalizedNode parentData)	Return an Augmentation instance backed by specified parent data.

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

deserializePathArgument, serializePathArgument

Method Details

filterFrom

@Nullable T filterFrom(@NonNull DataContainerNode parentData)

Return an Augmentation instance backed by specified parent data. Implementations are free to return either an eager transformation (not retaining parentData), or a lazy proxy. In both cases they must ensure the result has at least one property populated (i.e. is not empty).

Returns:

An Augmentation, or null if the augmentation would be empty

Throws:

NullPointerException - if parentData is null

IllegalArgumentException - if parentData is not a compatible parent

filterFrom

default @Nullable T filterFrom(@NonNull NormalizedNode parentData)

Return an Augmentation instance backed by specified parent data. Implementations are free to return either an eager transformation (not retaining parentData), or a lazy proxy. In both cases they must ensure the result has at least one property populated (i.e. is not empty).

Returns:

An Augmentation, or null if the augmentation would be empty

Throws:

NullPointerException - if parentData is null

IllegalArgumentException - if parentData is not a compatible DataContainerNode

childPathArguments

@NonNull ImmutableSet<YangInstanceIdentifier.NodeIdentifier> childPathArguments()

Returns the YangInstanceIdentifier.NodeIdentifiers of items contained in this Augmentation.

Returns:

A non-empty set of path arguments