Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.topology.config.rev180329

Class Topology1Builder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.topology.config.rev180329.Topology1Builder

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

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

   
     Topology1 createTopology1(int fooXyzzy, int barBaz) {
         return new Topology1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• Topology1

Constructor Summary

Constructors

Constructor	Description
Topology1Builder()	Construct an empty builder.
Topology1Builder(BgpTopologyConfiguration arg)	Construct a new builder initialized from specified BgpTopologyConfiguration.
Topology1Builder(Topology1 base)	Construct a builder initialized with state from specified Topology1.

Method Summary

Modifier and Type	Method	Description
@NonNull Topology1	build()	A new Topology1 instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
RibId	getRibId()	Return current value associated with the property corresponding to BgpTopologyConfiguration.getRibId().
Topology1Builder	setRibId(RibId value)	Set the property corresponding to BgpTopologyConfiguration.getRibId() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

Topology1Builder

public Topology1Builder()

Construct an empty builder.

Topology1Builder

public Topology1Builder(BgpTopologyConfiguration arg)

Construct a new builder initialized from specified BgpTopologyConfiguration.

Parameters:

arg - BgpTopologyConfiguration from which the builder should be initialized

Topology1Builder

public Topology1Builder(Topology1 base)

Construct a builder initialized with state from specified Topology1.

Parameters:

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

• BgpTopologyConfiguration

Parameters:

arg - grouping object

Throws:

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

getRibId

public RibId getRibId()

Return current value associated with the property corresponding to BgpTopologyConfiguration.getRibId().

Returns:

current value

setRibId

public Topology1Builder setRibId(RibId value)

Set the property corresponding to BgpTopologyConfiguration.getRibId() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull Topology1 build()

A new Topology1 instance.

Returns:

A new Topology1 instance.