Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329

Class NetworkInstanceProtocolBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NetworkInstanceProtocolBuilder

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

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

   
     NetworkInstanceProtocol createNetworkInstanceProtocol(int fooXyzzy, int barBaz) {
         return new NetworkInstanceProtocolBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• NetworkInstanceProtocol

Constructor Summary

Constructors

Constructor	Description
NetworkInstanceProtocolBuilder()	Construct an empty builder.
NetworkInstanceProtocolBuilder(BgpTop arg)	Construct a new builder initialized from specified BgpTop.
NetworkInstanceProtocolBuilder(NetworkInstanceProtocol base)	Construct a builder initialized with state from specified NetworkInstanceProtocol.

Method Summary

Modifier and Type	Method	Description
@NonNull NetworkInstanceProtocol	build()	A new NetworkInstanceProtocol instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Bgp	getBgp()	Return current value associated with the property corresponding to BgpTop.getBgp().
NetworkInstanceProtocolBuilder	setBgp(Bgp value)	Set the property corresponding to BgpTop.getBgp() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

NetworkInstanceProtocolBuilder

public NetworkInstanceProtocolBuilder()

Construct an empty builder.

NetworkInstanceProtocolBuilder

public NetworkInstanceProtocolBuilder(BgpTop arg)

Construct a new builder initialized from specified BgpTop.

Parameters:

arg - BgpTop from which the builder should be initialized

NetworkInstanceProtocolBuilder

public NetworkInstanceProtocolBuilder(NetworkInstanceProtocol base)

Construct a builder initialized with state from specified NetworkInstanceProtocol.

Parameters:

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

• BgpTop

Parameters:

arg - grouping object

Throws:

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

getBgp

public Bgp getBgp()

Return current value associated with the property corresponding to BgpTop.getBgp().

Returns:

current value

setBgp

public NetworkInstanceProtocolBuilder setBgp(Bgp value)

Set the property corresponding to BgpTop.getBgp() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull NetworkInstanceProtocol build()

A new NetworkInstanceProtocol instance.

Returns:

A new NetworkInstanceProtocol instance.