Package org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614

Class ClearNeighborsInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614.ClearNeighborsInputBuilder

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

Class that builds ClearNeighborsInput 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:

   
     ClearNeighborsInput createClearNeighborsInput(int fooXyzzy, int barBaz) {
         return new ClearNeighborsInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of ClearNeighborsInput, 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:

ClearNeighborsInput

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ClearNeighborsInputBuilder

public ClearNeighborsInputBuilder()

Construct an empty builder.

ClearNeighborsInputBuilder

public ClearNeighborsInputBuilder(ClearNeighborsInput base)

Construct a builder initialized with state from specified ClearNeighborsInput.

Parameters:

base - ClearNeighborsInput from which the builder should be initialized

Method Detail

getClearNeighborsRequest

public ClearNeighborsRequest getClearNeighborsRequest()

Return current value associated with the property corresponding to ClearNeighborsInput.getClearNeighborsRequest().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClearNeighborsInput>> 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

setClearNeighborsRequest

public ClearNeighborsInputBuilder setClearNeighborsRequest(ClearNeighborsRequest value)

Set the property corresponding to ClearNeighborsInput.getClearNeighborsRequest() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public ClearNeighborsInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ClearNeighborsInput> 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 ClearNeighborsInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClearNeighborsInput>> 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 ClearNeighborsInput build()

A new ClearNeighborsInput instance.

Returns:

A new ClearNeighborsInput instance.