Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009

Class Config3Builder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.Config3Builder

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

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

   
     Config3 createConfig3(int fooXyzzy, int barBaz) {
         return new Config3Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• Config3

Constructor Summary

Constructors

Constructor	Description
Config3Builder()	Construct an empty builder.
Config3Builder(BgpPeerGroupPeerGroupNameConfig arg)	Construct a new builder initialized from specified BgpPeerGroupPeerGroupNameConfig.
Config3Builder(Config3 base)	Construct a builder initialized with state from specified Config3.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Config3Builder

public Config3Builder()

Construct an empty builder.

Config3Builder

public Config3Builder(BgpPeerGroupPeerGroupNameConfig arg)

Construct a new builder initialized from specified BgpPeerGroupPeerGroupNameConfig.

Parameters:

arg - BgpPeerGroupPeerGroupNameConfig from which the builder should be initialized

Config3Builder

public Config3Builder(Config3 base)

Construct a builder initialized with state from specified Config3.

Parameters:

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

• BgpPeerGroupPeerGroupNameConfig

Parameters:

arg - grouping object

Throws:

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

getPeerGroupName

public String getPeerGroupName()

Return current value associated with the property corresponding to BgpPeerGroupPeerGroupNameConfig.getPeerGroupName().

Returns:

current value

setPeerGroupName

public Config3Builder setPeerGroupName(String value)

Set the property corresponding to BgpPeerGroupPeerGroupNameConfig.getPeerGroupName() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull Config3 build()

A new Config3 instance.

Returns:

A new Config3 instance.