org.opendaylight.yangtools.yang.binding

Class InstanceIdentifier.IdentifiableItem<I extends Identifiable<T> & DataObject,T extends Identifier<I>>

java.lang.Object

org.opendaylight.yangtools.yang.binding.InstanceIdentifier.IdentifiableItem<I,T>

Type Parameters:

I - An object that is identifiable by an identifier

T - The identifier of the object

All Implemented Interfaces:

Serializable, Comparable<InstanceIdentifier.PathArgument>, InstanceIdentifier.PathArgument

Enclosing class:

InstanceIdentifier<T extends DataObject>

public static class InstanceIdentifier.IdentifiableItem<I extends Identifiable<T> & DataObject,T extends Identifier<I>>
extends Object

An IdentifiableItem represents a object that is usually present in a collection and can be identified uniquely by a key. In YANG terms this would probably represent an item in a list.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IdentifiableItem(Class<I> type, T key) Deprecated. Use of(Class, Identifier) instead.

Method Summary

Modifier and Type	Method and Description
T	getKey() Return the data object type backing this PathArgument.
static <C extends ChoiceIn<?> & DataObject,T extends ChildOf<? super C> & Identifiable<I>,I extends Identifier<T>> InstanceIdentifier.IdentifiableItem<T,I>	of(Class<C> caseType, Class<T> type, I key) Return an IdentifiableItem instance backed by the specified class with specified key.
static <T extends Identifiable<I> & DataObject,I extends Identifier<T>> InstanceIdentifier.IdentifiableItem<T,I>	of(Class<T> type, I key) Return an IdentifiableItem instance backed by the specified class with specified key.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument

getCaseType

Constructor Detail

IdentifiableItem

@Deprecated
public IdentifiableItem(Class<I> type,
                                    T key)

Deprecated. Use of(Class, Identifier) instead.

Construct an Item.

Parameters:

type - Backing class

key - key

Method Detail

of

public static <T extends Identifiable<I> & DataObject,I extends Identifier<T>> InstanceIdentifier.IdentifiableItem<T,I> of(Class<T> type,
                                                                                                                           I key)

Return an IdentifiableItem instance backed by the specified class with specified key.

Type Parameters:

T - List type

I - Key type

Parameters:

type - Backing class

key - Key

Returns:

An IdentifiableItem

Throws:

NullPointerException - if any argument is null.

of

public static <C extends ChoiceIn<?> & DataObject,T extends ChildOf<? super C> & Identifiable<I>,I extends Identifier<T>> InstanceIdentifier.IdentifiableItem<T,I> of(Class<C> caseType,
                                                                                                                                                                      Class<T> type,
                                                                                                                                                                      I key)

Return an IdentifiableItem instance backed by the specified class with specified key. The class is in turn defined in a grouping used in a corresponding case statement.

Type Parameters:

C - Case type

T - List type

I - Key type

Parameters:

caseType - defining case class

type - Backing class

Returns:

A new PathArgument

Throws:

NullPointerException - if any argument is null.

getKey

public final T getKey()

Return the data object type backing this PathArgument.

Returns:

Data object type.

toString

public String toString()

Overrides:

toString in class Object