Class State3Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State3Builder
-
@Generated("mdsal-binding-generator") public class State3Builder extends Object
Class that buildsState3
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:
State3 createState3(int fooXyzzy, int barBaz) { return new State3Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of State3, 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:
State3
- 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 State3Builder()
Construct an empty builder.State3Builder(BgpNeighborAfiSafiState arg)
Construct a new builder initialized from specifiedBgpNeighborAfiSafiState
.State3Builder(BgpNeighborPrefixCountersState arg)
Construct a new builder initialized from specifiedBgpNeighborPrefixCountersState
.State3Builder(State3 base)
Construct a builder initialized with state from specifiedState3
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull State3
build()
A newState3
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getActive()
Return current value associated with the property corresponding toBgpNeighborAfiSafiState.getActive()
.Prefixes
getPrefixes()
Return current value associated with the property corresponding toBgpNeighborPrefixCountersState.getPrefixes()
.State3Builder
setActive(Boolean value)
Set the property corresponding toBgpNeighborAfiSafiState.getActive()
to the specified value.State3Builder
setPrefixes(Prefixes value)
Set the property corresponding toBgpNeighborPrefixCountersState.getPrefixes()
to the specified value.
-
-
-
Constructor Detail
-
State3Builder
public State3Builder()
Construct an empty builder.
-
State3Builder
public State3Builder(BgpNeighborAfiSafiState arg)
Construct a new builder initialized from specifiedBgpNeighborAfiSafiState
.- Parameters:
arg
- BgpNeighborAfiSafiState from which the builder should be initialized
-
State3Builder
public State3Builder(BgpNeighborPrefixCountersState arg)
Construct a new builder initialized from specifiedBgpNeighborPrefixCountersState
.- Parameters:
arg
- BgpNeighborPrefixCountersState 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
-
getActive
public Boolean getActive()
Return current value associated with the property corresponding toBgpNeighborAfiSafiState.getActive()
.- Returns:
- current value
-
getPrefixes
public Prefixes getPrefixes()
Return current value associated with the property corresponding toBgpNeighborPrefixCountersState.getPrefixes()
.- Returns:
- current value
-
setActive
public State3Builder setActive(Boolean value)
Set the property corresponding toBgpNeighborAfiSafiState.getActive()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefixes
public State3Builder setPrefixes(Prefixes value)
Set the property corresponding toBgpNeighborPrefixCountersState.getPrefixes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
-