Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720

Class Arguments1Builder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.Arguments1Builder

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

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

   
     Arguments1 createArguments1(int fooXyzzy, int barBaz) {
         return new Arguments1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• Arguments1

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NonNull Arguments1	build()	A new Arguments1 instance.
OperationalStatus	getOperational()	Return current value associated with the property corresponding to Arguments1.getOperational().
Arguments1Builder	setOperational(OperationalStatus value)	Set the property corresponding to Arguments1.getOperational() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

Arguments1Builder

public Arguments1Builder()

Construct an empty builder.

Arguments1Builder

public Arguments1Builder(Arguments1 base)

Construct a builder initialized with state from specified Arguments1.

Parameters:

base - Arguments1 from which the builder should be initialized

Method Details

getOperational

public OperationalStatus getOperational()

Return current value associated with the property corresponding to Arguments1.getOperational().

Returns:

current value

setOperational

public Arguments1Builder setOperational(OperationalStatus value)

Set the property corresponding to Arguments1.getOperational() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull Arguments1 build()

A new Arguments1 instance.

Returns:

A new Arguments1 instance.