Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.server.rev220321

Class PcepNodeConfigBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.server.rev220321.PcepNodeConfigBuilder

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

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

   
     PcepNodeConfig createPcepNodeConfig(int fooXyzzy, int barBaz) {
         return new PcepNodeConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• PcepNodeConfig

Constructor Summary

Constructors

Constructor	Description
PcepNodeConfigBuilder()	Construct an empty builder.
PcepNodeConfigBuilder(PccConfiguredLsp arg)	Construct a new builder initialized from specified PccConfiguredLsp.
PcepNodeConfigBuilder(PcepNodeConfig base)	Construct a builder initialized with state from specified PcepNodeConfig.

Method Summary

Modifier and Type	Method	Description
@NonNull PcepNodeConfig	build()	A new PcepNodeConfig instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Map<ConfiguredLspKey,ConfiguredLsp>	getConfiguredLsp()	Return current value associated with the property corresponding to PccConfiguredLsp.getConfiguredLsp().
PcepNodeConfigBuilder	setConfiguredLsp(Map<ConfiguredLspKey,ConfiguredLsp> values)	Set the property corresponding to PccConfiguredLsp.getConfiguredLsp() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

PcepNodeConfigBuilder

public PcepNodeConfigBuilder()

Construct an empty builder.

PcepNodeConfigBuilder

public PcepNodeConfigBuilder(PccConfiguredLsp arg)

Construct a new builder initialized from specified PccConfiguredLsp.

Parameters:

arg - PccConfiguredLsp from which the builder should be initialized

PcepNodeConfigBuilder

public PcepNodeConfigBuilder(PcepNodeConfig base)

Construct a builder initialized with state from specified PcepNodeConfig.

Parameters:

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

• PccConfiguredLsp

Parameters:

arg - grouping object

Throws:

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

getConfiguredLsp

public Map<ConfiguredLspKey,ConfiguredLsp> getConfiguredLsp()

Return current value associated with the property corresponding to PccConfiguredLsp.getConfiguredLsp().

Returns:

current value

setConfiguredLsp

public PcepNodeConfigBuilder setConfiguredLsp(Map<ConfiguredLspKey,ConfiguredLsp> values)

Set the property corresponding to PccConfiguredLsp.getConfiguredLsp() to the specified value.

Parameters:

values - desired value

Returns:

this builder

build

public @NonNull PcepNodeConfig build()

A new PcepNodeConfig instance.

Returns:

A new PcepNodeConfig instance.