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

Interface BindingInstanceIdentifierCodec

All Superinterfaces:

Immutable

@Beta
public interface BindingInstanceIdentifierCodec
extends Immutable

Method Summary

Modifier and Type	Method	Description
default @NonNull YangInstanceIdentifier	fromBinding(@NonNull BindingInstanceIdentifier bindingPath)	Translates supplied BindingInstanceIdentifier into a YangInstanceIdentifier.
default @NonNull YangInstanceIdentifier	fromBinding(@NonNull DataObjectIdentifier<?> bindingPath)	Translates supplied DataObjectIdentifier into a YangInstanceIdentifier.
@NonNull YangInstanceIdentifier	fromBinding(@NonNull DataObjectReference<?> bindingPath)	Translates supplied DataObjectReference into a YangInstanceIdentifier.
@NonNull YangInstanceIdentifier	fromBinding(@NonNull PropertyIdentifier<?,?> bindingPath)	Translates supplied PropertyIdentifier into a YangInstanceIdentifier.
<T extends DataObject> @Nullable DataObjectReference<T>	toBinding(@NonNull YangInstanceIdentifier domPath)	Translates supplied YangInstanceIdentifier into a DataObjectReference, if possible.
@Nullable BindingInstanceIdentifier	toBindingInstanceIdentifier(@NonNull YangInstanceIdentifier domPath)	Translates supplied YangInstanceIdentifier into a BindingInstanceIdentifier, if possible.

Method Details

toBinding

<T extends DataObject>
@Nullable DataObjectReference<T> toBinding(@NonNull YangInstanceIdentifier domPath)

Translates supplied YangInstanceIdentifier into a DataObjectReference, if possible.

Parameters:

domPath - YANG Instance Identifier

Returns:

a DataObjectReference, or null if the instance identifier is not representable.

Throws:

NullPointerException - if domPath is null

IllegalArgumentException - if domPath is not valid.

toBindingInstanceIdentifier

@Nullable BindingInstanceIdentifier toBindingInstanceIdentifier(@NonNull YangInstanceIdentifier domPath)

Translates supplied YangInstanceIdentifier into a BindingInstanceIdentifier, if possible. Identifiers which refer to ChoiceNode, MapNode, UnkeyedListNode and LeafSetNode are impossible to translate into a BindingInstanceIdentifier because they are an addressing artifact of NormalizedNode representation.

Parameters:

domPath - YANG Instance Identifier

Returns:

BindingInstanceIdentifier, or null if the YangInstanceIdentifier is not representable.

Throws:

NullPointerException - if domPath is null

IllegalArgumentException - if domPath is not valid.

fromBinding

@NonNull YangInstanceIdentifier fromBinding(@NonNull DataObjectReference<?> bindingPath)

Translates supplied DataObjectReference into a YangInstanceIdentifier.

Parameters:

bindingPath - a data object reference

Returns:

DOM Instance Identifier

Throws:

NullPointerException - if bindingPath is null

IllegalArgumentException - if bindingPath is not valid.

fromBinding

default @NonNull YangInstanceIdentifier fromBinding(@NonNull DataObjectIdentifier<?> bindingPath)

Translates supplied DataObjectIdentifier into a YangInstanceIdentifier.

Parameters:

bindingPath - a data object reference

Returns:

DOM Instance Identifier

Throws:

NullPointerException - if bindingPath is null

IllegalArgumentException - if bindingPath is not valid.

fromBinding

@NonNull YangInstanceIdentifier fromBinding(@NonNull PropertyIdentifier<?,?> bindingPath)

Translates supplied PropertyIdentifier into a YangInstanceIdentifier.

Parameters:

bindingPath - a property identifier

Returns:

DOM Instance Identifier

Throws:

NullPointerException - if bindingPath is null

IllegalArgumentException - if bindingPath is not valid.

fromBinding

default @NonNull YangInstanceIdentifier fromBinding(@NonNull BindingInstanceIdentifier bindingPath)

Translates supplied BindingInstanceIdentifier into a YangInstanceIdentifier.

Parameters:

bindingPath - Binding Instance Identifier

Returns:

DOM Instance Identifier

Throws:

NullPointerException - if bindingPath is null

IllegalArgumentException - if bindingPath is not valid.