Package org.opendaylight.yangtools.yang.data.api

Interface YangInstanceIdentifier.InstanceIdentifierBuilder

All Superinterfaces:

Builder<YangInstanceIdentifier>, CheckedBuilder<YangInstanceIdentifier,IllegalArgumentException>, Mutable, MutationBehaviour<Mutable>

Enclosing class:

YangInstanceIdentifier

public static interface YangInstanceIdentifier.InstanceIdentifierBuilder
extends Builder<YangInstanceIdentifier>

Fluent Builder of Instance Identifier instances.

Method Summary

Modifier and Type	Method	Description
@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder	append(Collection<? extends YangInstanceIdentifier.PathArgument> args)	Adds a collection of YangInstanceIdentifier.PathArguments to path arguments of resulting instance identifier.
default @NonNull YangInstanceIdentifier.InstanceIdentifierBuilder	append(YangInstanceIdentifier.PathArgument... args)	Adds a collection of YangInstanceIdentifier.PathArguments to path arguments of resulting instance identifier.
YangInstanceIdentifier	build()	Builds an YangInstanceIdentifier with path arguments from this builder.
@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder	node(QName nodeType)	Adds YangInstanceIdentifier.NodeIdentifier with supplied QName to path arguments of resulting instance identifier.
@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder	node(YangInstanceIdentifier.PathArgument arg)	Adds a YangInstanceIdentifier.PathArgument to path arguments of resulting instance identifier.
@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder	nodeWithKey(QName nodeType, Map<QName,Object> keyValues)	Adds YangInstanceIdentifier.NodeIdentifierWithPredicates with supplied QName and key values to path arguments of resulting instance identifier.
@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder	nodeWithKey(QName nodeType, QName key, Object value)	Adds YangInstanceIdentifier.NodeIdentifierWithPredicates with supplied QName and key, value.

Method Detail

node

@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder node(YangInstanceIdentifier.PathArgument arg)

Adds a YangInstanceIdentifier.PathArgument to path arguments of resulting instance identifier.

Parameters:

arg - A YangInstanceIdentifier.PathArgument to be added

Returns:

this builder

node

@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder node(QName nodeType)

Adds YangInstanceIdentifier.NodeIdentifier with supplied QName to path arguments of resulting instance identifier.

Parameters:

nodeType - QName of YangInstanceIdentifier.NodeIdentifier which will be added

Returns:

this builder

nodeWithKey

@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder nodeWithKey(QName nodeType,
                                                                      Map<QName,Object> keyValues)

Adds YangInstanceIdentifier.NodeIdentifierWithPredicates with supplied QName and key values to path arguments of resulting instance identifier.

Parameters:

nodeType - QName of YangInstanceIdentifier.NodeIdentifierWithPredicates which will be added

keyValues - Map of key components and their respective values for YangInstanceIdentifier.NodeIdentifierWithPredicates

Returns:

this builder

nodeWithKey

@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder nodeWithKey(QName nodeType,
                                                                      QName key,
                                                                      Object value)

Adds YangInstanceIdentifier.NodeIdentifierWithPredicates with supplied QName and key, value.

Parameters:

nodeType - QName of YangInstanceIdentifier.NodeIdentifierWithPredicates which will be added

key - QName of key which will be added

value - value of key which will be added

Returns:

this builder

append

@NonNull YangInstanceIdentifier.InstanceIdentifierBuilder append(Collection<? extends YangInstanceIdentifier.PathArgument> args)

Adds a collection of YangInstanceIdentifier.PathArguments to path arguments of resulting instance identifier.

Parameters:

args - YangInstanceIdentifier.PathArguments to be added

Returns:

this builder

Throws:

NullPointerException - if any of the arguments is null

append

default @NonNull YangInstanceIdentifier.InstanceIdentifierBuilder append(YangInstanceIdentifier.PathArgument... args)

Adds a collection of YangInstanceIdentifier.PathArguments to path arguments of resulting instance identifier.

Parameters:

args - YangInstanceIdentifier.PathArguments to be added

Returns:

this builder

Throws:

NullPointerException - if any of the arguments is null

build

YangInstanceIdentifier build()

Builds an YangInstanceIdentifier with path arguments from this builder.

Specified by:

build in interface Builder<YangInstanceIdentifier>

Specified by:

build in interface CheckedBuilder<YangInstanceIdentifier,IllegalArgumentException>

Returns:

YangInstanceIdentifier