Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.rev130819

Class TopologyTypes1Builder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.rev130819.TopologyTypes1Builder

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

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

   
     TopologyTypes1 createTopologyTypes1(int fooXyzzy, int barBaz) {
         return new TopologyTypes1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• TopologyTypes1

Constructor Summary

Constructors

Constructor	Description
TopologyTypes1Builder()	Construct an empty builder.
TopologyTypes1Builder(TopologyTunnelType arg)	Construct a new builder initialized from specified TopologyTunnelType.
TopologyTypes1Builder(TopologyTypes1 base)	Construct a builder initialized with state from specified TopologyTypes1.

Method Summary

Modifier and Type	Method	Description
@NonNull TopologyTypes1	build()	A new TopologyTypes1 instance.
void	fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg)	Set fields from given grouping argument.
TopologyTunnel	getTopologyTunnel()	Return current value associated with the property corresponding to TopologyTunnelType.getTopologyTunnel().
TopologyTypes1Builder	setTopologyTunnel(TopologyTunnel value)	Set the property corresponding to TopologyTunnelType.getTopologyTunnel() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

TopologyTypes1Builder

public TopologyTypes1Builder()

Construct an empty builder.

TopologyTypes1Builder

public TopologyTypes1Builder(TopologyTunnelType arg)

Construct a new builder initialized from specified TopologyTunnelType.

Parameters:

arg - TopologyTunnelType from which the builder should be initialized

TopologyTypes1Builder

public TopologyTypes1Builder(TopologyTypes1 base)

Construct a builder initialized with state from specified TopologyTypes1.

Parameters:

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

• TopologyTunnelType

Parameters:

arg - grouping object

Throws:

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

getTopologyTunnel

public TopologyTunnel getTopologyTunnel()

Return current value associated with the property corresponding to TopologyTunnelType.getTopologyTunnel().

Returns:

current value

setTopologyTunnel

public TopologyTypes1Builder setTopologyTunnel(TopologyTunnel value)

Set the property corresponding to TopologyTunnelType.getTopologyTunnel() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull TopologyTypes1 build()

A new TopologyTypes1 instance.

Returns:

A new TopologyTypes1 instance.