Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109.tunnel.pcep.supporting.node.attributes

Class PathComputationClientBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109.tunnel.pcep.supporting.node.attributes.PathComputationClientBuilder

@Generated("mdsal-binding-generator")
public class PathComputationClientBuilder
extends Object

Class that builds PathComputationClient instances. Overall design of the class is that of a fluent interface, where method chaining is used.

In general, this class is supposed to be used like this template:

   
     PathComputationClient createPathComputationClient(int fooXyzzy, int barBaz) {
         return new PathComputationClientBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of PathComputationClient, as instances can be freely passed around without worrying about synchronization issues.

As a side note: method chaining results in:

• very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is on the stack, so further method invocations just need to fill method arguments for the next method invocation, which is terminated by build(), which is then returned from the method
• better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
• better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated

See Also:

• PathComputationClient

Constructor Summary

Constructors

Constructor	Description
PathComputationClientBuilder()	Construct an empty builder.
PathComputationClientBuilder(PathComputationClient base)	Construct a builder initialized with state from specified PathComputationClient.

Method Summary

Modifier and Type	Method	Description
PathComputationClientBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull PathComputationClient	build()	A new PathComputationClient instance.
static @NonNull PathComputationClient	empty()	Get empty instance of PathComputationClient.
Boolean	getControlling()	Return current value associated with the property corresponding to PathComputationClient.getControlling().
PathComputationClientBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient>> augmentationType)	Remove an augmentation from this builder's product.
PathComputationClientBuilder	setControlling(Boolean value)	Set the property corresponding to PathComputationClient.getControlling() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

PathComputationClientBuilder

public PathComputationClientBuilder()

Construct an empty builder.

PathComputationClientBuilder

public PathComputationClientBuilder(PathComputationClient base)

Construct a builder initialized with state from specified PathComputationClient.

Parameters:

base - PathComputationClient from which the builder should be initialized

Method Details

empty

public static @NonNull PathComputationClient empty()

Get empty instance of PathComputationClient.

Returns:

An empty PathComputationClient

getControlling

public Boolean getControlling()

Return current value associated with the property corresponding to PathComputationClient.getControlling().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient>>
E$$ augmentation(Class<E$$> augmentationType)

Return the specified augmentation, if it is present in this builder.

Type Parameters:

E$$ - augmentation type

Parameters:

augmentationType - augmentation type class

Returns:

Augmentation object from this builder, or null if not present

Throws:

NullPointerException - if augmentType is null

setControlling

public PathComputationClientBuilder setControlling(Boolean value)

Set the property corresponding to PathComputationClient.getControlling() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public PathComputationClientBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

public PathComputationClientBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient>> augmentationType)

Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.

Parameters:

augmentationType - augmentation type to be removed

Returns:

this builder

build

public @NonNull PathComputationClient build()

A new PathComputationClient instance.

Returns:

A new PathComputationClient instance.