Class State2Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State2Builder
-
@Generated("mdsal-binding-generator") public class State2Builder extends Object
Class that buildsState2
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:
State2 createState2(int fooXyzzy, int barBaz) { return new State2Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of State2, 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:
State2
- 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
-
-
Constructor Summary
Constructors Constructor Description State2Builder()
Construct an empty builder.State2Builder(BgpNeighborAfiSafiGracefulRestartState arg)
Construct a new builder initialized from specifiedBgpNeighborAfiSafiGracefulRestartState
.State2Builder(State2 base)
Construct a builder initialized with state from specifiedState2
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull State2
build()
A newState2
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getAdvertised()
Return current value associated with the property corresponding toBgpNeighborAfiSafiGracefulRestartState.getAdvertised()
.Boolean
getReceived()
Return current value associated with the property corresponding toBgpNeighborAfiSafiGracefulRestartState.getReceived()
.State2Builder
setAdvertised(Boolean value)
Set the property corresponding toBgpNeighborAfiSafiGracefulRestartState.getAdvertised()
to the specified value.State2Builder
setReceived(Boolean value)
Set the property corresponding toBgpNeighborAfiSafiGracefulRestartState.getReceived()
to the specified value.
-
-
-
Constructor Detail
-
State2Builder
public State2Builder()
Construct an empty builder.
-
State2Builder
public State2Builder(BgpNeighborAfiSafiGracefulRestartState arg)
Construct a new builder initialized from specifiedBgpNeighborAfiSafiGracefulRestartState
.- Parameters:
arg
- BgpNeighborAfiSafiGracefulRestartState from which the builder should be initialized
-
-
Method Detail
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAdvertised
public Boolean getAdvertised()
Return current value associated with the property corresponding toBgpNeighborAfiSafiGracefulRestartState.getAdvertised()
.- Returns:
- current value
-
getReceived
public Boolean getReceived()
Return current value associated with the property corresponding toBgpNeighborAfiSafiGracefulRestartState.getReceived()
.- Returns:
- current value
-
setAdvertised
public State2Builder setAdvertised(Boolean value)
Set the property corresponding toBgpNeighborAfiSafiGracefulRestartState.getAdvertised()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReceived
public State2Builder setReceived(Boolean value)
Set the property corresponding toBgpNeighborAfiSafiGracefulRestartState.getReceived()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
-