Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.bgp.rib.route

Class PmsiTunnelAugmentationBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.bgp.rib.route.PmsiTunnelAugmentationBuilder

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

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

   
     PmsiTunnelAugmentation createPmsiTunnelAugmentation(int fooXyzzy, int barBaz) {
         return new PmsiTunnelAugmentationBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• PmsiTunnelAugmentation

Constructor Summary

Constructors

Constructor	Description
PmsiTunnelAugmentationBuilder()	Construct an empty builder.
PmsiTunnelAugmentationBuilder(PmsiTunnelAugmentation base)	Construct a builder initialized with state from specified PmsiTunnelAugmentation.
PmsiTunnelAugmentationBuilder(PmsiTunnel arg)	Construct a new builder initialized from specified PmsiTunnel.

Method Summary

Modifier and Type	Method	Description
@NonNull PmsiTunnelAugmentation	build()	A new PmsiTunnelAugmentation instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
PmsiTunnel	getPmsiTunnel()	Return current value associated with the property corresponding to PmsiTunnel.getPmsiTunnel().
PmsiTunnelAugmentationBuilder	setPmsiTunnel(PmsiTunnel value)	Set the property corresponding to PmsiTunnel.getPmsiTunnel() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

PmsiTunnelAugmentationBuilder

public PmsiTunnelAugmentationBuilder()

Construct an empty builder.

PmsiTunnelAugmentationBuilder

public PmsiTunnelAugmentationBuilder(PmsiTunnel arg)

Construct a new builder initialized from specified PmsiTunnel.

Parameters:

arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.PmsiTunnel from which the builder should be initialized

PmsiTunnelAugmentationBuilder

public PmsiTunnelAugmentationBuilder(PmsiTunnelAugmentation base)

Construct a builder initialized with state from specified PmsiTunnelAugmentation.

Parameters:

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

• PmsiTunnel

Parameters:

arg - grouping object

Throws:

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

getPmsiTunnel

public PmsiTunnel getPmsiTunnel()

Return current value associated with the property corresponding to PmsiTunnel.getPmsiTunnel().

Returns:

current value

setPmsiTunnel

public PmsiTunnelAugmentationBuilder setPmsiTunnel(PmsiTunnel value)

Set the property corresponding to PmsiTunnel.getPmsiTunnel() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull PmsiTunnelAugmentation build()

A new PmsiTunnelAugmentation instance.

Returns:

A new PmsiTunnelAugmentation instance.