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

Class PeerGroup1Builder

java.lang.Object

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

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

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

   
     PeerGroup1 createPeerGroup1(int fooXyzzy, int barBaz) {
         return new PeerGroup1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• PeerGroup1

Constructor Summary

Constructors

Constructor	Description
PeerGroup1Builder()	Construct an empty builder.
PeerGroup1Builder(BgpUseMultiplePaths arg)	Construct a new builder initialized from specified BgpUseMultiplePaths.
PeerGroup1Builder(PeerGroup1 base)	Construct a builder initialized with state from specified PeerGroup1.

Method Summary

Modifier and Type	Method	Description
@NonNull PeerGroup1	build()	A new PeerGroup1 instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
UseMultiplePaths	getUseMultiplePaths()	Return current value associated with the property corresponding to BgpUseMultiplePaths.getUseMultiplePaths().
PeerGroup1Builder	setUseMultiplePaths(UseMultiplePaths value)	Set the property corresponding to BgpUseMultiplePaths.getUseMultiplePaths() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

PeerGroup1Builder

public PeerGroup1Builder()

Construct an empty builder.

PeerGroup1Builder

public PeerGroup1Builder(BgpUseMultiplePaths arg)

Construct a new builder initialized from specified BgpUseMultiplePaths.

Parameters:

arg - BgpUseMultiplePaths from which the builder should be initialized

PeerGroup1Builder

public PeerGroup1Builder(PeerGroup1 base)

Construct a builder initialized with state from specified PeerGroup1.

Parameters:

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

• BgpUseMultiplePaths

Parameters:

arg - grouping object

Throws:

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

getUseMultiplePaths

public UseMultiplePaths getUseMultiplePaths()

Return current value associated with the property corresponding to BgpUseMultiplePaths.getUseMultiplePaths().

Returns:

current value

setUseMultiplePaths

public PeerGroup1Builder setUseMultiplePaths(UseMultiplePaths value)

Set the property corresponding to BgpUseMultiplePaths.getUseMultiplePaths() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull PeerGroup1 build()

A new PeerGroup1 instance.

Returns:

A new PeerGroup1 instance.