Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.pcep.topology.provider.rev230115

Class TopologyPcep1Builder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.pcep.topology.provider.rev230115.TopologyPcep1Builder

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

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

   
     TopologyPcep1 createTopologyPcep1(int fooXyzzy, int barBaz) {
         return new TopologyPcep1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• TopologyPcep1

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NonNull TopologyPcep1	build()	A new TopologyPcep1 instance.
Capabilities	getCapabilities()	Return current value associated with the property corresponding to TopologyPcep1.getCapabilities().
TopologyPcep1Builder	setCapabilities(Capabilities value)	Set the property corresponding to TopologyPcep1.getCapabilities() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

TopologyPcep1Builder

public TopologyPcep1Builder()

Construct an empty builder.

TopologyPcep1Builder

public TopologyPcep1Builder(TopologyPcep1 base)

Construct a builder initialized with state from specified TopologyPcep1.

Parameters:

base - TopologyPcep1 from which the builder should be initialized

Method Details

getCapabilities

public Capabilities getCapabilities()

Return current value associated with the property corresponding to TopologyPcep1.getCapabilities().

Returns:

current value

setCapabilities

public TopologyPcep1Builder setCapabilities(Capabilities value)

Set the property corresponding to TopologyPcep1.getCapabilities() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull TopologyPcep1 build()

A new TopologyPcep1 instance.

Returns:

A new TopologyPcep1 instance.