Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.anchors.top

Class IntegratedCircuitBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.anchors.top.IntegratedCircuitBuilder

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

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

   
     IntegratedCircuit createIntegratedCircuit(int fooXyzzy, int barBaz) {
         return new IntegratedCircuitBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

IntegratedCircuit

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegratedCircuitBuilder

public IntegratedCircuitBuilder()

Construct an empty builder.

IntegratedCircuitBuilder

public IntegratedCircuitBuilder(IntegratedCircuit base)

Construct a builder initialized with state from specified IntegratedCircuit.

Parameters:

base - IntegratedCircuit from which the builder should be initialized

Method Detail

getConfig

public Config getConfig()

Return current value associated with the property corresponding to IntegratedCircuit.getConfig().

Returns:

current value

getState

public State getState()

Return current value associated with the property corresponding to IntegratedCircuit.getState().

Returns:

current value

augmentation

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

setConfig

public IntegratedCircuitBuilder setConfig(Config value)

Set the property corresponding to IntegratedCircuit.getConfig() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setState

public IntegratedCircuitBuilder setState(State value)

Set the property corresponding to IntegratedCircuit.getState() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new IntegratedCircuit instance.

Returns:

A new IntegratedCircuit instance.