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

Class NeighborPeerGroupConfigBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instance.protocol.NeighborPeerGroupConfigBuilder

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

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

   
     NeighborPeerGroupConfig createNeighborPeerGroupConfig(int fooXyzzy, int barBaz) {
         return new NeighborPeerGroupConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• NeighborPeerGroupConfig

Constructor Summary

Constructors

Constructor	Description
NeighborPeerGroupConfigBuilder()	Construct an empty builder.
NeighborPeerGroupConfigBuilder(BgpNeighborPeerGroupConfig arg)	Construct a new builder initialized from specified BgpNeighborPeerGroupConfig.
NeighborPeerGroupConfigBuilder(NeighborPeerGroupConfig base)	Construct a builder initialized with state from specified NeighborPeerGroupConfig.

Method Summary

Modifier and Type	Method	Description
@NonNull NeighborPeerGroupConfig	build()	A new NeighborPeerGroupConfig instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
String	getPeerGroup()	Return current value associated with the property corresponding to BgpNeighborPeerGroupConfig.getPeerGroup().
NeighborPeerGroupConfigBuilder	setPeerGroup(String value)	Set the property corresponding to BgpNeighborPeerGroupConfig.getPeerGroup() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

NeighborPeerGroupConfigBuilder

public NeighborPeerGroupConfigBuilder()

Construct an empty builder.

NeighborPeerGroupConfigBuilder

public NeighborPeerGroupConfigBuilder(BgpNeighborPeerGroupConfig arg)

Construct a new builder initialized from specified BgpNeighborPeerGroupConfig.

Parameters:

arg - BgpNeighborPeerGroupConfig from which the builder should be initialized

NeighborPeerGroupConfigBuilder

public NeighborPeerGroupConfigBuilder(NeighborPeerGroupConfig base)

Construct a builder initialized with state from specified NeighborPeerGroupConfig.

Parameters:

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

• BgpNeighborPeerGroupConfig

Parameters:

arg - grouping object

Throws:

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

getPeerGroup

public String getPeerGroup()

Return current value associated with the property corresponding to BgpNeighborPeerGroupConfig.getPeerGroup().

Returns:

current value

setPeerGroup

public NeighborPeerGroupConfigBuilder setPeerGroup(String value)

Set the property corresponding to BgpNeighborPeerGroupConfig.getPeerGroup() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull NeighborPeerGroupConfig build()

A new NeighborPeerGroupConfig instance.

Returns:

A new NeighborPeerGroupConfig instance.