Package org.opendaylight.yangtools.binding

Interface DataObjectIdentifier.Builder<T extends DataObject>

Type Parameters:

T - type of DataObject held in the last step.

All Superinterfaces:

DataObjectReference.Builder<T>

All Known Subinterfaces:

DataObjectIdentifier.Builder.WithKey<T,K>

All Known Implementing Classes:

AbstractDataObjectIdentifierBuilder, DataObjectIdentifierBuilder, DataObjectIdentifierBuilderWithKey

Enclosing interface:

DataObjectIdentifier<T extends DataObject>

public static sealed interface DataObjectIdentifier.Builder<T extends DataObject>
extends DataObjectReference.Builder<T>
permits DataObjectIdentifier.Builder.WithKey<T,K>, AbstractDataObjectIdentifierBuilder<T>

A builder of DataObjectReference objects.

Nested Class Summary

Nested Classes

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.

Method Summary

Modifier and Type	Method	Description
<A extends Augmentation<? super T>> DataObjectIdentifier.Builder<A>	augmentation(Class<A> augmentation)	Update this builder to build a reference to a specific augmentation of the data object this builder currently points to.
DataObjectIdentifier<T>	build()	Build the data object reference.
<N extends EntryObject<N, K> & ChildOf<? super T>, K extends Key<N>> DataObjectIdentifier.Builder.WithKey<N,K>	child(Class<@NonNull N> listItem, K listKey)	Append the specified listItem as a child of the data object this build currently references.
<C extends ChoiceIn<? super T> & DataObject, N extends ChildOf<? super C>> DataObjectIdentifier.Builder<N>	child(Class<C> caze, Class<N> container)	Append the specified container 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>> DataObjectIdentifier.Builder.WithKey<N,K>	child(Class<C> caze, Class<N> listItem, K listKey)	Append the specified listItem as a child of the data object this build currently references.
<N extends ChildOf<? super T>> DataObjectIdentifier.Builder<N>	child(Class<N> container)	Append the specified container as a child of the data object this build currently references.

Method Details

augmentation

<A extends Augmentation<? super T>>
DataObjectIdentifier.Builder<A> augmentation(Class<A> augmentation)

Description copied from interface: DataObjectReference.Builder

Update this builder to build a reference to a specific augmentation of the data object this builder currently points to.

Specified by:

augmentation in interface DataObjectReference.Builder<T extends DataObject>

Type Parameters:

A - augmentation type

Parameters:

augmentation - augmentation class

Returns:

this builder

child

<N extends ChildOf<? super T>>
DataObjectIdentifier.Builder<N> child(Class<N> container)

Description copied from interface: DataObjectReference.Builder

Append the specified container as a child of the data object this build currently references. This method should be used when you want to build an instance identifier by appending top-level elements.

Specified by:

child in interface DataObjectReference.Builder<T extends DataObject>

Type Parameters:

N - Container type

Parameters:

container - Container to append

Returns:

this builder

child

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

Description copied from interface: DataObjectReference.Builder

Append the specified container as a child of the data object this build currently references. This method should be used when you want to build an reference by appending a container node to the identifier and the container is defined in a grouping used in a case statement.

Specified by:

child in interface DataObjectReference.Builder<T extends DataObject>

Type Parameters:

C - Case type

N - Container type

Parameters:

caze - Choice case class

container - Container to append

Returns:

this builder

child

<C extends ChoiceIn<? super T> & DataObject,
K extends Key<N>,
N extends EntryObject<N,
K> & ChildOf<? super C>>
DataObjectIdentifier.Builder.WithKey<N,K> child(Class<C> caze,
 Class<N> listItem,
 K listKey)

Description copied from interface: DataObjectReference.Builder

Append the specified listItem as a child of the data object this build currently references. This method should be used when you want to build a reference by appending a specific list element to the identifier and the list is defined in a grouping used in a case statement.

Specified by:

child in interface DataObjectReference.Builder<T extends DataObject>

Type Parameters:

C - Case type

K - Key type

N - List type

Parameters:

caze - Choice case class

listItem - List to append

listKey - List key

Returns:

this builder

child

<N extends EntryObject<N,
K> & ChildOf<? super T>,
K extends Key<N>>
DataObjectIdentifier.Builder.WithKey<N,K> child(Class<@NonNull N> listItem,
 K listKey)

Description copied from interface: DataObjectReference.Builder

Append the specified listItem as a child of the data object this build currently references. This method should be used when you want to build a reference by appending a specific list element to the identifier.

Specified by:

child in interface DataObjectReference.Builder<T extends DataObject>

Type Parameters:

N - List type

K - Key type

Parameters:

listItem - List to append

listKey - List key

Returns:

this builder

build

DataObjectIdentifier<T> build()

Description copied from interface: DataObjectReference.Builder

Build the data object reference.

Specified by:

build in interface DataObjectReference.Builder<T extends DataObject>

Returns:

resulting DataObjectReference.