org.opendaylight.mdsal.binding.javav2.spec.base

Interface InstanceIdentifierBuilder<T extends TreeNode>

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>

@Beta
public interface InstanceIdentifierBuilder<T extends TreeNode>
extends org.opendaylight.yangtools.concepts.Builder<InstanceIdentifier<T>>

Method Summary

Modifier and Type	Method and Description
<N extends TreeNode & Augmentation<? super T>> 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.
<N extends TreeNode & TreeChildNode<? super T,Item<N>>> InstanceIdentifierBuilder<N>	child(Class<N> container) Append the specified container as a child of the current InstanceIdentifier referenced by the builder.
<N extends TreeChildNode<? super T,?>,K> InstanceIdentifierBuilder<N>	child(Class<N> listItem, K listKey) Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder.
InstanceIdentifier<T>	toInstance() Deprecated.

Method Detail

child

<N extends TreeNode & TreeChildNode<? super T,Item<N>>> 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 -

Parameters:

container -

Returns:

child

<N extends TreeChildNode<? super T,?>,K> 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 -

K -

Parameters:

listItem -

listKey -

Returns:

augmentation

<N extends TreeNode & Augmentation<? super T>> 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 -

Parameters:

container -

Returns:

build

InstanceIdentifier<T> build()

Build the instance identifier.

Specified by:

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

Returns:

toInstance

@Deprecated
InstanceIdentifier<T> toInstance()

Deprecated.