Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.config.rev181109

Class PcepTopologyTypeConfigBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.config.rev181109.PcepTopologyTypeConfigBuilder

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

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

   
     PcepTopologyTypeConfig createPcepTopologyTypeConfig(int fooXyzzy, int barBaz) {
         return new PcepTopologyTypeConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• PcepTopologyTypeConfig

Constructor Summary

Constructors

Constructor	Description
PcepTopologyTypeConfigBuilder()	Construct an empty builder.
PcepTopologyTypeConfigBuilder(PcepConfig arg)	Construct a new builder initialized from specified PcepConfig.
PcepTopologyTypeConfigBuilder(PcepTopologyTypeConfig base)	Construct a builder initialized with state from specified PcepTopologyTypeConfig.

Method Summary

Modifier and Type	Method	Description
@NonNull PcepTopologyTypeConfig	build()	A new PcepTopologyTypeConfig instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
SessionConfig	getSessionConfig()	Return current value associated with the property corresponding to PcepConfig.getSessionConfig().
PcepTopologyTypeConfigBuilder	setSessionConfig(SessionConfig value)	Set the property corresponding to PcepConfig.getSessionConfig() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

PcepTopologyTypeConfigBuilder

public PcepTopologyTypeConfigBuilder()

Construct an empty builder.

PcepTopologyTypeConfigBuilder

public PcepTopologyTypeConfigBuilder(PcepConfig arg)

Construct a new builder initialized from specified PcepConfig.

Parameters:

arg - PcepConfig from which the builder should be initialized

PcepTopologyTypeConfigBuilder

public PcepTopologyTypeConfigBuilder(PcepTopologyTypeConfig base)

Construct a builder initialized with state from specified PcepTopologyTypeConfig.

Parameters:

base - PcepTopologyTypeConfig 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:

• PcepConfig

Parameters:

arg - grouping object

Throws:

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

getSessionConfig

public SessionConfig getSessionConfig()

Return current value associated with the property corresponding to PcepConfig.getSessionConfig().

Returns:

current value

setSessionConfig

public PcepTopologyTypeConfigBuilder setSessionConfig(SessionConfig value)

Set the property corresponding to PcepConfig.getSessionConfig() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull PcepTopologyTypeConfig build()

A new PcepTopologyTypeConfig instance.

Returns:

A new PcepTopologyTypeConfig instance.