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

Class State6Builder

java.lang.Object

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

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

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

   
     State6 createState6(int fooXyzzy, int barBaz) {
         return new State6Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• State6

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NonNull State6	build()	A new State6 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().
State6Builder	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

State6Builder

public State6Builder()

Construct an empty builder.

State6Builder

public State6Builder(BgpNeighborPeerGroupConfig arg)

Construct a new builder initialized from specified BgpNeighborPeerGroupConfig.

Parameters:

arg - BgpNeighborPeerGroupConfig from which the builder should be initialized

State6Builder

public State6Builder(State6 base)

Construct a builder initialized with state from specified State6.

Parameters:

base - State6 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 State6Builder setPeerGroup(String value)

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

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull State6 build()

A new State6 instance.

Returns:

A new State6 instance.