Package org.opendaylight.yangtools.binding.impl

Class AbstractDataObjectReferenceBuilder<T extends DataObject>

java.lang.Object

org.opendaylight.yangtools.binding.impl.AbstractDataObjectReferenceBuilder<T>

All Implemented Interfaces:

DataObjectReference.Builder<T>

Direct Known Subclasses:

AbstractDataObjectIdentifierBuilder, DataObjectReferenceBuilder, DataObjectReferenceBuilderWithKey, InstanceIdentifier.Builder

public abstract sealed class AbstractDataObjectReferenceBuilder<T extends DataObject>
extends Object
implements DataObjectReference.Builder<T>
permits AbstractDataObjectIdentifierBuilder<T>, DataObjectReferenceBuilder<T>, DataObjectReferenceBuilderWithKey<T,K>, InstanceIdentifier.Builder<T>

Base implementation of DataObjectReference.Builder.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.binding.DataObjectReference.Builder

DataObjectReference.Builder.WithKey<T extends EntryObject<T,K>,K extends Key<T>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDataObjectReferenceBuilder(DataObjectReference<T> base)
protected	AbstractDataObjectReferenceBuilder(DataObjectStep<?> item)
protected	AbstractDataObjectReferenceBuilder(ExactDataObjectStep<?> item)
protected	AbstractDataObjectReferenceBuilder(AbstractDataObjectReferenceBuilder<?> prev)

Method Summary

Modifier and Type	Method	Description
protected abstract <X extends DataObject> @NonNull DataObjectReference.Builder<X>	append(@NonNull DataObjectStep<X> step)
protected abstract <X extends EntryObject<X, Y>, Y extends Key<X>> @NonNull DataObjectReference.Builder.WithKey<X,Y>	append(@NonNull KeyStep<Y,X> step)
protected final void	appendItem(@NonNull ExactDataObjectStep<?> item)
protected void	appendItem(@NonNull InexactDataObjectStep<?> item)
protected final void	appendItem(DataObjectStep<?> item)
<A extends Augmentation<? super T>> DataObjectReference.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.
abstract DataObjectReference<T>	build()	Build the data object reference.
protected final @NonNull Iterable<? extends @NonNull DataObjectStep<?>>	buildSteps()
<C extends ChoiceIn<? super T> & DataObject, N extends ChildOf<? super C>> DataObjectReference.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>> DataObjectReference.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>> DataObjectReference.Builder<N>	child(Class<N> container)	Append the specified container as a child of the data object this build currently references.
<N extends EntryObject<N, K> & ChildOf<? super T>, K extends Key<N>> DataObjectReference.Builder.WithKey<N,K>	child(Class<N> listItem, K listKey)	Append the specified listItem as a child of the data object this build currently references.
protected final boolean	wildcard()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractDataObjectReferenceBuilder

protected AbstractDataObjectReferenceBuilder(AbstractDataObjectReferenceBuilder<?> prev)

AbstractDataObjectReferenceBuilder

protected AbstractDataObjectReferenceBuilder(DataObjectReference<T> base)

AbstractDataObjectReferenceBuilder

protected AbstractDataObjectReferenceBuilder(DataObjectStep<?> item)

AbstractDataObjectReferenceBuilder

protected AbstractDataObjectReferenceBuilder(ExactDataObjectStep<?> item)

Method Details

augmentation

public <A extends Augmentation<? super T>>
DataObjectReference.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

public <N extends ChildOf<? super T>>
DataObjectReference.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

public <C extends ChoiceIn<? super T> & DataObject,
N extends ChildOf<? super C>>
DataObjectReference.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

public <N extends EntryObject<N,
K> & ChildOf<? super T>,
K extends Key<N>>
DataObjectReference.Builder.WithKey<N,K> child(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.

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

child

public <C extends ChoiceIn<? super T> & DataObject,
K extends Key<N>,
N extends EntryObject<N,
K> & ChildOf<? super C>>
DataObjectReference.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

build

public abstract DataObjectReference<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.

append

protected abstract <X extends DataObject>
@NonNull DataObjectReference.Builder<X> append(@NonNull DataObjectStep<X> step)

append

protected abstract <X extends EntryObject<X,
Y>,
Y extends Key<X>>
@NonNull DataObjectReference.Builder.WithKey<X,Y> append(@NonNull KeyStep<Y,X> step)

wildcard

protected final boolean wildcard()

appendItem

protected final void appendItem(DataObjectStep<?> item)

appendItem

protected final void appendItem(@NonNull ExactDataObjectStep<?> item)

appendItem

protected void appendItem(@NonNull InexactDataObjectStep<?> item)

buildSteps

protected final @NonNull Iterable<? extends @NonNull DataObjectStep<?>> buildSteps()