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

Class StatefulTlv1Builder

java.lang.Object

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

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

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

   
     StatefulTlv1 createStatefulTlv1(int fooXyzzy, int barBaz) {
         return new StatefulTlv1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• StatefulTlv1

Constructor Summary

Constructors

Constructor	Description
StatefulTlv1Builder()	Construct an empty builder.
StatefulTlv1Builder(StatefulCapabilityTlv arg)	Construct a new builder initialized from specified StatefulCapabilityTlv.
StatefulTlv1Builder(StatefulTlv1 base)	Construct a builder initialized with state from specified StatefulTlv1.

Method Summary

Modifier and Type	Method	Description
@NonNull StatefulTlv1	build()	A new StatefulTlv1 instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Stateful	getStateful()	Return current value associated with the property corresponding to StatefulCapabilityTlv.getStateful().
StatefulTlv1Builder	setStateful(Stateful value)	Set the property corresponding to StatefulCapabilityTlv.getStateful() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

StatefulTlv1Builder

public StatefulTlv1Builder()

Construct an empty builder.

StatefulTlv1Builder

public StatefulTlv1Builder(StatefulCapabilityTlv arg)

Construct a new builder initialized from specified StatefulCapabilityTlv.

Parameters:

arg - StatefulCapabilityTlv from which the builder should be initialized

StatefulTlv1Builder

public StatefulTlv1Builder(StatefulTlv1 base)

Construct a builder initialized with state from specified StatefulTlv1.

Parameters:

base - StatefulTlv1 from which the builder should be initialized

Method Details

fieldsFrom

public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)

Set fields from given grouping argument. Valid argument is instance of one of following types:

• StatefulCapabilityTlv

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

getStateful

public Stateful getStateful()

Return current value associated with the property corresponding to StatefulCapabilityTlv.getStateful().

Returns:

current value

setStateful

public StatefulTlv1Builder setStateful(Stateful value)

Set the property corresponding to StatefulCapabilityTlv.getStateful() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull StatefulTlv1 build()

A new StatefulTlv1 instance.

Returns:

A new StatefulTlv1 instance.