Package org.opendaylight.yangtools.binding

Interface DataObjectReference.WithKey<T extends EntryObject<T,K>,K extends Key<T>>

Type Parameters:

T - EntryObject type

K - Key type

All Superinterfaces:

DataObjectReference<T>, Immutable, KeyAware<K>, Serializable

All Known Subinterfaces:

DataObjectIdentifier.WithKey<T,K>

All Known Implementing Classes:

DataObjectIdentifierWithKey, DataObjectReferenceWithKey, KeyedInstanceIdentifier

Enclosing interface:

DataObjectReference<T extends DataObject>

public static sealed interface DataObjectReference.WithKey<T extends EntryObject<T,K>,K extends Key<T>>
extends DataObjectReference<T>, KeyAware<K>
permits DataObjectIdentifier.WithKey<T,K>, DataObjectReferenceWithKey<T,K>, KeyedInstanceIdentifier<T,K>

A DataObjectReference pointing to a EntryObject.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.binding.DataObjectReference

DataObjectReference.Builder<T extends DataObject>, DataObjectReference.WithKey<T extends EntryObject<T,K>,K extends Key<T>>

Method Summary

Modifier and Type	Method	Description
default @NonNull K	getKey()	Deprecated. Use key() instead.
default K	key()	Returns an unique key for the object.
KeyStep<K,T>	lastStep()	Return the last step of this reference.
DataObjectReference.Builder.WithKey<T,K>	toBuilder()	Create a new DataObjectReference.Builder initialized to produce a reference equal to this one.
DataObjectIdentifier.WithKey<T,K>	toIdentifier()	Return a DataObjectIdentifier view of this reference, if possible.
default @NonNull KeyedInstanceIdentifier<T,K>	toLegacy()	Return a legacy KeyedInstanceIdentifier for this reference.

Methods inherited from interface org.opendaylight.yangtools.binding.DataObjectReference

builder, getPathArguments, isExact, isWildcarded, steps

Method Details

lastStep

KeyStep<K,T> lastStep()

Description copied from interface: DataObjectReference

Return the last step of this reference.

Specified by:

lastStep in interface DataObjectReference<T extends EntryObject<T,K>>

Returns:

the last step

toBuilder

DataObjectReference.Builder.WithKey<T,K> toBuilder()

Description copied from interface: DataObjectReference

Create a new DataObjectReference.Builder initialized to produce a reference equal to this one.

Specified by:

toBuilder in interface DataObjectReference<T extends EntryObject<T,K>>

Returns:

A builder instance

toIdentifier

DataObjectIdentifier.WithKey<T,K> toIdentifier()

Description copied from interface: DataObjectReference

Return a DataObjectIdentifier view of this reference, if possible.

Specified by:

toIdentifier in interface DataObjectReference<T extends EntryObject<T,K>>

Returns:

A DataObjectIdentifier

toLegacy

default @NonNull KeyedInstanceIdentifier<T,K> toLegacy()

Return a legacy KeyedInstanceIdentifier for this reference.

Specified by:

toLegacy in interface DataObjectReference<T extends EntryObject<T,K>>

Returns:

A KeyedInstanceIdentifier.

key

default K key()

Description copied from interface: KeyAware

Returns an unique key for the object.

Specified by:

key in interface KeyAware<T extends EntryObject<T,K>>

Returns:

Key for the object

getKey

@Deprecated(since="14.0.0")
default @NonNull K getKey()

Deprecated.

Use key() instead.

Return the key attached to this identifier. This method is equivalent to calling InstanceIdentifier.keyOf(InstanceIdentifier).

Returns:

Key associated with this instance identifier.