org.opendaylight.yangtools.yang.binding

Interface InstanceIdentifier.InstanceIdentifierBuilder<T extends DataObject>

All Superinterfaces:

org.opendaylight.yangtools.concepts.Builder<InstanceIdentifier<T>>, org.opendaylight.yangtools.concepts.CheckedBuilder<InstanceIdentifier<T>,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

Enclosing class:

InstanceIdentifier<T extends DataObject>

public static interface InstanceIdentifier.InstanceIdentifierBuilder<T extends DataObject>
extends org.opendaylight.yangtools.concepts.Builder<InstanceIdentifier<T>>

Method Summary

Modifier and Type	Method and Description
<N extends DataObject & Augmentation<? super T>> InstanceIdentifier.InstanceIdentifierBuilder<N>	augmentation(Class<N> container) Build an identifier which refers to a specific augmentation of the current InstanceIdentifier referenced by the builder.
InstanceIdentifier<T>	build() Build the instance identifier.
<C extends ChoiceIn<? super T> & DataObject,N extends ChildOf<? super C>> InstanceIdentifier.InstanceIdentifierBuilder<N>	child(Class<C> caze, Class<N> container) Append the specified container as a child of the current InstanceIdentifier referenced by the builder.
<C extends ChoiceIn<? super T> & DataObject,K extends Identifier<N>,N extends Identifiable<K> & ChildOf<? super C>> InstanceIdentifier.InstanceIdentifierBuilder<N>	child(Class<C> caze, Class<N> listItem, K listKey) Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder.
<N extends ChildOf<? super T>> InstanceIdentifier.InstanceIdentifierBuilder<N>	child(Class<N> container) Append the specified container as a child of the current InstanceIdentifier referenced by the builder.
<N extends Identifiable<K> & ChildOf<? super T>,K extends Identifier<N>> InstanceIdentifier.InstanceIdentifierBuilder<N>	child(Class<N> listItem, K listKey) Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder.

Method Detail

child

<N extends ChildOf<? super T>> InstanceIdentifier.InstanceIdentifierBuilder<N> child(Class<N> container)

Append the specified container as a child of the current InstanceIdentifier referenced by the builder. This method should be used when you want to build an instance identifier by appending top-level elements Example,

     InstanceIdentifier.builder().child(Nodes.class).build();
 

NOTE :- The above example is only for illustration purposes InstanceIdentifier.builder() has been deprecated and should not be used. Use InstanceIdentifier.builder(Nodes.class) instead

Type Parameters:

N - Container type

Parameters:

container - Container to append

Returns:

this builder

Throws:

NullPointerException - if container is null

child

<C extends ChoiceIn<? super T> & DataObject,N extends ChildOf<? super C>> InstanceIdentifier.InstanceIdentifierBuilder<N> child(Class<C> caze,
                                                                                                                                Class<N> container)

Append the specified container as a child of the current InstanceIdentifier referenced by the builder. This method should be used when you want to build an instance identifier by appending a container node to the identifier and the container is defined in a grouping used in a case statement.

Type Parameters:

C - Case type

N - Container type

Parameters:

caze - Choice case class

container - Container to append

Returns:

this builder

Throws:

NullPointerException - if container is null

child

<N extends Identifiable<K> & ChildOf<? super T>,K extends Identifier<N>> InstanceIdentifier.InstanceIdentifierBuilder<N> child(Class<N> listItem,
                                                                                                                               K listKey)

Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder. This method should be used when you want to build an instance identifier by appending a specific list element to the identifier

Type Parameters:

N - List type

K - Key type

Parameters:

listItem - List to append

listKey - List key

Returns:

this builder

Throws:

NullPointerException - if any argument is null

child

<C extends ChoiceIn<? super T> & DataObject,K extends Identifier<N>,N extends Identifiable<K> & ChildOf<? super C>> InstanceIdentifier.InstanceIdentifierBuilder<N> child(Class<C> caze,
                                                                                                                                                                          Class<N> listItem,
                                                                                                                                                                          K listKey)

Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder. This method should be used when you want to build an instance identifier by appending a specific list element to the identifier and the list is defined in a grouping used in a case statement.

Type Parameters:

C - Case type

N - List type

K - Key type

Parameters:

caze - Choice case class

listItem - List to append

listKey - List key

Returns:

this builder

Throws:

NullPointerException - if any argument is null

augmentation

<N extends DataObject & Augmentation<? super T>> InstanceIdentifier.InstanceIdentifierBuilder<N> augmentation(Class<N> container)

Build an identifier which refers to a specific augmentation of the current InstanceIdentifier referenced by the builder.

Type Parameters:

N - augmentation type

Parameters:

container - augmentation class

Returns:

this builder

Throws:

NullPointerException - if container is null

build

InstanceIdentifier<T> build()

Build the instance identifier.

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<InstanceIdentifier<T extends DataObject>,IllegalArgumentException>

Returns:

Resulting instance identifier.