Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720

Class Tlvs2Builder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.Tlvs2Builder

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

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

   
     Tlvs2 createTlvs2(int fooXyzzy, int barBaz) {
         return new Tlvs2Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• Tlvs2

Constructor Summary

Constructors

Constructor	Description
Tlvs2Builder()	Construct an empty builder.
Tlvs2Builder(SrPceCapabilityTlv arg)	Construct a new builder initialized from specified SrPceCapabilityTlv.
Tlvs2Builder(Tlvs2 base)	Construct a builder initialized with state from specified Tlvs2.

Method Summary

Modifier and Type	Method	Description
@NonNull Tlvs2	build()	A new Tlvs2 instance.
void	fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg)	Set fields from given grouping argument.
SrPceCapability	getSrPceCapability()	Return current value associated with the property corresponding to SrPceCapabilityTlv.getSrPceCapability().
Tlvs2Builder	setSrPceCapability(SrPceCapability value)	Set the property corresponding to SrPceCapabilityTlv.getSrPceCapability() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

Tlvs2Builder

public Tlvs2Builder()

Construct an empty builder.

Tlvs2Builder

public Tlvs2Builder(SrPceCapabilityTlv arg)

Construct a new builder initialized from specified SrPceCapabilityTlv.

Parameters:

arg - SrPceCapabilityTlv from which the builder should be initialized

Tlvs2Builder

public Tlvs2Builder(Tlvs2 base)

Construct a builder initialized with state from specified Tlvs2.

Parameters:

base - Tlvs2 from which the builder should be initialized

Method Details

fieldsFrom

public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg)

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

• SrPceCapabilityTlv

Parameters:

arg - grouping object

Throws:

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

getSrPceCapability

public SrPceCapability getSrPceCapability()

Return current value associated with the property corresponding to SrPceCapabilityTlv.getSrPceCapability().

Returns:

current value

setSrPceCapability

public Tlvs2Builder setSrPceCapability(SrPceCapability value)

Set the property corresponding to SrPceCapabilityTlv.getSrPceCapability() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull Tlvs2 build()

A new Tlvs2 instance.

Returns:

A new Tlvs2 instance.