Uses of Interface
org.opendaylight.yangtools.binding.Key

Packages that use Key

Package	Description
org.opendaylight.yangtools.binding
org.opendaylight.yangtools.binding.data.codec.api	API elements of a codec capable translating YANG-modeled data between its BindingObjects and NormalizedData representations.
org.opendaylight.yangtools.binding.impl	Internal implementation details.
org.opendaylight.yangtools.binding.lib	Library of utilities for use by generated code.
org.opendaylight.yangtools.binding.util
org.opendaylight.yangtools.yang.binding

Uses of Key in org.opendaylight.yangtools.binding

Classes in org.opendaylight.yangtools.binding with type parameters of type Key

Modifier and Type	Interface	Description
static interface	DataObjectIdentifier.Builder.WithKey<T extends EntryObject<T,K>,K extends Key<T>>	A builder of DataObjectReference.WithKey objects.
static interface	DataObjectIdentifier.WithKey<T extends EntryObject<T,K>,K extends Key<T>>	A DataObjectIdentifier pointing to an EntryObject.
static interface	DataObjectReference.Builder.WithKey<T extends EntryObject<T,K>,K extends Key<T>>	A builder of DataObjectReference.WithKey objects.
static interface	DataObjectReference.WithKey<T extends EntryObject<T,K>,K extends Key<T>>	A DataObjectReference pointing to a EntryObject.
interface	EntryObject<T extends EntryObject<T,K>,K extends Key<T>>	A DataObject which represents a single entry in a list with a key -- and hence it has a KeyAware.key().
interface	KeyAware<T extends Key<? extends EntryObject<?,T>>>	Identifiable object, which could be identified by it's key.
interface	KeyedListAction<K extends Key<T>,T extends EntryObject<T,K>,I extends RpcInput,O extends RpcOutput>	Interface extended by all interfaces generated for a YANG action instantiated in keyed lists.
interface	KeyedListNotification<N extends KeyedListNotification<N,T,K>,T extends EntryObject<T,K>,K extends Key<T>>	An notification which is defined within the schema tree and is thus tied to a data tree instance and additionally its parent is a {code list} with a key statement.
final record	KeyStep<K extends Key<T>,T extends EntryObject<T,K>>	A EntryObject-based step with a KeyStep.key().

Methods in org.opendaylight.yangtools.binding with type parameters of type Key

Modifier and Type	Method	Description
static <C extends ChoiceIn<? extends DataRoot<?>> & DataObject, N extends EntryObject<N, K> & ChildOf<? super C>, K extends Key<N>> @NonNull DataObjectIdentifier.Builder.WithKey<N,K>	DataObjectIdentifier.builder(@NonNull Class<C> caze, @NonNull Class<N> listItem, @NonNull K listKey)
static <N extends EntryObject<N, K> & ChildOf<? extends DataRoot<?>>, K extends Key<N>> @NonNull DataObjectIdentifier.Builder.WithKey<N,K>	DataObjectIdentifier.builder(Class<N> listItem, K listKey)
static <C extends ChoiceIn<? extends DataRoot<?>> & DataObject, N extends EntryObject<N, K> & ChildOf<? super C>, K extends Key<N>> @NonNull DataObjectReference.Builder.WithKey<N,K>	DataObjectReference.builder(@NonNull Class<C> caze, @NonNull Class<N> listItem, @NonNull K listKey)
static <N extends EntryObject<N, K> & ChildOf<? extends DataRoot<?>>, K extends Key<N>> @NonNull DataObjectReference.Builder.WithKey<N,K>	DataObjectReference.builder(Class<N> listItem, K listKey)
static <R extends DataRoot<R>, N extends EntryObject<N, K> & ChildOf<? super R>, K extends Key<N>> @NonNull DataObjectIdentifier.Builder.WithKey<N,K>	DataObjectIdentifier.builderOfInherited(@NonNull Class<R> root, @NonNull Class<N> listItem, @NonNull K listKey)
static <R extends DataRoot<R>, C extends ChoiceIn<? super R> & DataObject, N extends EntryObject<N, K> & ChildOf<? super C>, K extends Key<N>> @NonNull DataObjectIdentifier.Builder.WithKey<N,K>	DataObjectIdentifier.builderOfInherited(Class<R> root, Class<C> caze, Class<N> listItem, K listKey)
static <R extends DataRoot<R>, N extends EntryObject<N, K> & ChildOf<? super R>, K extends Key<N>> @NonNull DataObjectReference.Builder.WithKey<N,K>	DataObjectReference.builderOfInherited(@NonNull Class<R> root, @NonNull Class<N> listItem, @NonNull K listKey)
static <R extends DataRoot<R>, C extends ChoiceIn<? super R> & DataObject, N extends EntryObject<N, K> & ChildOf<? super C>, K extends Key<N>> @NonNull DataObjectReference.Builder.WithKey<N,K>	DataObjectReference.builderOfInherited(Class<R> root, Class<C> caze, Class<N> listItem, K listKey)
<N extends EntryObject<N, K> & ChildOf<? super T>, K extends Key<N>> DataObjectIdentifier.Builder.WithKey<N,K>	DataObjectIdentifier.Builder.child(Class<@NonNull N> listItem, K listKey)
<C extends ChoiceIn<? super T> & DataObject, K extends Key<N>, N extends EntryObject<N, K> & ChildOf<? super C>> DataObjectIdentifier.Builder.WithKey<N,K>	DataObjectIdentifier.Builder.child(Class<C> caze, Class<N> listItem, K listKey)
<N extends EntryObject<N, K> & ChildOf<? super T>, K extends Key<N>> @NonNull DataObjectReference.Builder.WithKey<N,K>	DataObjectReference.Builder.child(@NonNull Class<@NonNull N> listItem, @NonNull K listKey)	Append the specified listItem as a child of the data object this build currently references.
<C extends ChoiceIn<? super T> & DataObject, K extends Key<N>, N extends EntryObject<N, K> & ChildOf<? super C>> @NonNull DataObjectReference.Builder.WithKey<N,K>	DataObjectReference.Builder.child(@NonNull Class<C> caze, @NonNull Class<N> listItem, @NonNull K listKey)	Append the specified listItem as a child of the data object this build currently references.
default <E extends EntryObject<E, K>, K extends Key<E>> Optional<K>	DataObjectReference.findFirstKeyOf(Class<@NonNull E> listItem)	Returns an Optional containing the Key associated with the first component of specified type in this reference.
<E extends EntryObject<E, K>, K extends Key<E>> @Nullable K	DataObjectReference.firstKeyOf(Class<@NonNull E> listItem)	Returns the Key associated with the first component of specified type in this reference.
default <E extends EntryObject<E, K>, K extends Key<E>> @NonNull K	DataObjectReference.getFirstKeyOf(Class<@NonNull E> listItem)	Returns the Key associated with the first component of specified type in this reference, throwing NoSuchElementException if no match is found.

Uses of Key in org.opendaylight.yangtools.binding.data.codec.api

Methods in org.opendaylight.yangtools.binding.data.codec.api with parameters of type Key

Modifier and Type	Method	Description
void	BindingStreamEventWriter.startMapEntryNode(Key<?> keyValues, int childSizeHint)	Emits start of map entry.

Uses of Key in org.opendaylight.yangtools.binding.impl

Classes in org.opendaylight.yangtools.binding.impl with type parameters of type Key

Modifier and Type	Class	Description
final class	DataObjectIdentifierBuilderWithKey<T extends EntryObject<T,K>,K extends Key<T>>
final class	DataObjectIdentifierWithKey<T extends EntryObject<T,K>,K extends Key<T>>
final class	DataObjectReferenceBuilderWithKey<T extends EntryObject<T,K>,K extends Key<T>>
final class	DataObjectReferenceWithKey<T extends EntryObject<T,K>,K extends Key<T>>

Methods in org.opendaylight.yangtools.binding.impl with type parameters of type Key

Modifier and Type	Method	Description
protected abstract <X extends EntryObject<X, Y>, Y extends Key<X>> DataObjectIdentifier.Builder.WithKey<X,Y>	AbstractDataObjectIdentifierBuilder.append(KeyStep<Y,X> step)
protected abstract <X extends EntryObject<X, Y>, Y extends Key<X>> @NonNull DataObjectReference.Builder.WithKey<X,Y>	AbstractDataObjectReferenceBuilder.append(@NonNull KeyStep<Y,X> step)
protected <X extends EntryObject<X, Y>, Y extends Key<X>> DataObjectIdentifierBuilderWithKey<X,Y>	DataObjectIdentifierBuilder.append(KeyStep<Y,X> step)
protected <X extends EntryObject<X, Y>, Y extends Key<X>> DataObjectIdentifierBuilderWithKey<X,Y>	DataObjectIdentifierBuilderWithKey.append(KeyStep<Y,X> step)
protected <X extends EntryObject<X, Y>, Y extends Key<X>> DataObjectReferenceBuilderWithKey<X,Y>	DataObjectReferenceBuilder.append(KeyStep<Y,X> step)
protected <X extends EntryObject<X, Y>, Y extends Key<X>> DataObjectReferenceBuilderWithKey<X,Y>	DataObjectReferenceBuilderWithKey.append(KeyStep<Y,X> step)
<C extends ChoiceIn<? super T> & DataObject, K extends Key<N>, N extends EntryObject<N, K> & ChildOf<? super C>> DataObjectIdentifier.Builder.WithKey<N,K>	AbstractDataObjectIdentifierBuilder.child(Class<C> caze, Class<N> listItem, K listKey)
<N extends EntryObject<N, K> & ChildOf<? super T>, K extends Key<N>> DataObjectIdentifier.Builder.WithKey<N,K>	AbstractDataObjectIdentifierBuilder.child(Class<N> listItem, K listKey)
<C extends ChoiceIn<? super T> & DataObject, K extends Key<N>, N extends EntryObject<N, K> & ChildOf<? super C>> DataObjectReference.Builder.WithKey<N,K>	AbstractDataObjectReferenceBuilder.child(Class<C> caze, Class<N> listItem, K listKey)
<N extends EntryObject<N, K> & ChildOf<? super T>, K extends Key<N>> DataObjectReference.Builder.WithKey<N,K>	AbstractDataObjectReferenceBuilder.child(Class<N> listItem, K listKey)
<N extends EntryObject<N, K>, K extends Key<N>> @Nullable K	AbstractDataObjectReference.firstKeyOf(Class<@NonNull N> listItem)

Uses of Key in org.opendaylight.yangtools.binding.lib

Classes in org.opendaylight.yangtools.binding.lib with type parameters of type Key

Modifier and Type	Class	Description
class	AbstractEntryObject<T extends EntryObject<T,K>,K extends Key<T>>	Abstract base class for implementations of EntryObject.

Uses of Key in org.opendaylight.yangtools.binding.util

Classes in org.opendaylight.yangtools.binding.util with type parameters of type Key

Modifier and Type	Class	Description
static class	BindingMap.Builder<K extends Key<V>,V extends EntryObject<V,K>>	Builder producing a Map containing binding EntryObject values.

Methods in org.opendaylight.yangtools.binding.util with type parameters of type Key

Modifier and Type	Method	Description
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull BindingMap.Builder<K,V>	BindingMap.builder()	Create a builder on an unmodifiable map, which does not retain value insertion order.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull BindingMap.Builder<K,V>	BindingMap.builder(int expectedSize)	Create a builder on an unmodifiable map, which does not retain value insertion order.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(Collection<V> values)	Returns an unmodifiable map containing given values.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1)	Returns an unmodifiable map containing a single mapping.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V... values)	Returns an unmodifiable map containing given values.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2)	Returns an unmodifiable map containing two mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2, V v3)	Returns an unmodifiable map containing three mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2, V v3, V v4)	Returns an unmodifiable map containing four mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2, V v3, V v4, V v5)	Returns an unmodifiable map containing five mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2, V v3, V v4, V v5, V v6)	Returns an unmodifiable map containing six mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2, V v3, V v4, V v5, V v6, V v7)	Returns an unmodifiable map containing seven mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2, V v3, V v4, V v5, V v6, V v7, V v8)	Returns an unmodifiable map containing eight mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2, V v3, V v4, V v5, V v6, V v7, V v8, V v9)	Returns an unmodifiable map containing nine mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.of(V v1, V v2, V v3, V v4, V v5, V v6, V v7, V v8, V v9, V v10)	Returns an unmodifiable map containing ten mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.ordered(Collection<V> values)	Returns an unmodifiable map containing given values.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.ordered(V... values)	Returns an unmodifiable map containing given values.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.ordered(V v1, V v2)	Returns an unmodifiable map containing two mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.ordered(V v1, V v2, V v3)	Returns an unmodifiable map containing three mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.ordered(V v1, V v2, V v3, V v4)	Returns an unmodifiable map containing four mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Map<K,V>	BindingMap.ordered(V v1, V v2, V v3, V v4, V v5)	Returns an unmodifiable map containing five mappings.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull BindingMap.Builder<K,V>	BindingMap.orderedBuilder()	Create a builder on an unmodifiable map, which retains value insertion order.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull BindingMap.Builder<K,V>	BindingMap.orderedBuilder(int expectedSize)	Create a builder on an unmodifiable map, which retains value insertion order.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Collector<V,?,? extends Map<K,V>>	BindingMap.toMap()	Returns a collector which collects binding EntryObjects into an unmodifiable map.
static <K extends Key<V>, V extends EntryObject<V, K>> @NonNull Collector<V,?,? extends Map<K,V>>	BindingMap.toOrderedMap()	Returns a collector which collects binding EntryObjects into an unmodifiable map.

Uses of Key in org.opendaylight.yangtools.yang.binding

Classes in org.opendaylight.yangtools.yang.binding with type parameters of type Key

Modifier and Type	Class	Description
static final class	InstanceIdentifier.KeyedBuilder<T extends EntryObject<T,K>,K extends Key<T>>	Deprecated.
final class	KeyedInstanceIdentifier<T extends EntryObject<T,K>,K extends Key<T>>	An InstanceIdentifier, which has a list key attached at its last path element.

Methods in org.opendaylight.yangtools.yang.binding with type parameters of type Key

Modifier and Type	Method	Description
protected abstract <X extends EntryObject<X, Y>, Y extends Key<X>> @NonNull InstanceIdentifier.KeyedBuilder<X,Y>	InstanceIdentifier.Builder.append(KeyStep<Y,X> step)
protected <X extends EntryObject<X, Y>, Y extends Key<X>> InstanceIdentifier.KeyedBuilder<X,Y>	InstanceIdentifier.KeyedBuilder.append(KeyStep<Y,X> step)
static <C extends ChoiceIn<? extends DataRoot<?>> & DataObject, N extends EntryObject<N, K> & ChildOf<? super C>, K extends Key<N>> @NonNull InstanceIdentifier.KeyedBuilder<N,K>	InstanceIdentifier.builder(@NonNull Class<C> caze, @NonNull Class<N> listItem, @NonNull K listKey)	Deprecated. Create a InstanceIdentifier.Builder for a specific type of InstanceIdentifier which represents an EntryObject in a grouping used in the case statement.
static <N extends EntryObject<N, K> & ChildOf<? extends DataRoot<?>>, K extends Key<N>> @NonNull InstanceIdentifier.KeyedBuilder<N,K>	InstanceIdentifier.builder(Class<N> listItem, K listKey)	Deprecated. Create a InstanceIdentifier.Builder for a specific type of InstanceIdentifier which represents an EntryObject.
static <R extends DataRoot<R>, N extends EntryObject<N, K> & ChildOf<? super R>, K extends Key<N>> @NonNull InstanceIdentifier.KeyedBuilder<N,K>	InstanceIdentifier.builderOfInherited(@NonNull Class<R> root, @NonNull Class<N> listItem, @NonNull K listKey)	Deprecated.
static <R extends DataRoot<R>, C extends ChoiceIn<? super R> & DataObject, N extends EntryObject<N, K> & ChildOf<? super C>, K extends Key<N>> @NonNull InstanceIdentifier.KeyedBuilder<N,K>	InstanceIdentifier.builderOfInherited(Class<R> root, Class<C> caze, Class<N> listItem, K listKey)	Deprecated.
final <N extends EntryObject<N, K> & ChildOf<? super T>, K extends Key<N>> InstanceIdentifier.KeyedBuilder<N,K>	InstanceIdentifier.Builder.child(Class<@NonNull N> listItem, K listKey)
final <C extends ChoiceIn<? super T> & DataObject, K extends Key<N>, N extends EntryObject<N, K> & ChildOf<? super C>> InstanceIdentifier.KeyedBuilder<N,K>	InstanceIdentifier.Builder.child(Class<C> caze, Class<N> listItem, K listKey)
final <C extends ChoiceIn<? super T> & DataObject, K extends Key<N>, N extends EntryObject<N, K> & ChildOf<? super C>> @NonNull KeyedInstanceIdentifier<N,K>	InstanceIdentifier.child(Class<@NonNull C> caze, Class<@NonNull N> listItem, K listKey)	Deprecated. Create an InstanceIdentifier for a child list item.
final <N extends EntryObject<N, K> & ChildOf<? super T>, K extends Key<N>> @NonNull KeyedInstanceIdentifier<N,K>	InstanceIdentifier.child(Class<@NonNull N> listItem, K listKey)	Deprecated. Create an InstanceIdentifier for a child list item.
final <E extends EntryObject<E, K>, K extends Key<E>> @Nullable K	InstanceIdentifier.firstKeyOf(Class<@NonNull E> listItem)	Deprecated.
static <N extends EntryObject<N, K>, K extends Key<N>> K	InstanceIdentifier.keyOf(InstanceIdentifier<N> id)	Deprecated. Return the key associated with the last component of the specified identifier.