Class State8Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State8Builder
-
@Generated("mdsal-binding-generator") public class State8Builder extends Object
Class that buildsState8
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:
State8 createState8(int fooXyzzy, int barBaz) { return new State8Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of State8, 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:
State8
- 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 State8Builder()
Construct an empty builder.State8Builder(BgpNeighborState arg)
Construct a new builder initialized from specifiedBgpNeighborState
.State8Builder(State8 base)
Construct a builder initialized with state from specifiedState8
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull State8
build()
A newState8
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BgpNeighborState.SessionState
getSessionState()
Return current value associated with the property corresponding toBgpNeighborState.getSessionState()
.Set<Class<? extends BgpCapability>>
getSupportedCapabilities()
Return current value associated with the property corresponding toBgpNeighborState.getSupportedCapabilities()
.State8Builder
setSessionState(BgpNeighborState.SessionState value)
Set the property corresponding toBgpNeighborState.getSessionState()
to the specified value.State8Builder
setSupportedCapabilities(Set<Class<? extends BgpCapability>> values)
Set the property corresponding toBgpNeighborState.getSupportedCapabilities()
to the specified value.
-
-
-
Constructor Detail
-
State8Builder
public State8Builder()
Construct an empty builder.
-
State8Builder
public State8Builder(BgpNeighborState arg)
Construct a new builder initialized from specifiedBgpNeighborState
.- Parameters:
arg
- BgpNeighborState 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
-
getSessionState
public BgpNeighborState.SessionState getSessionState()
Return current value associated with the property corresponding toBgpNeighborState.getSessionState()
.- Returns:
- current value
-
getSupportedCapabilities
public Set<Class<? extends BgpCapability>> getSupportedCapabilities()
Return current value associated with the property corresponding toBgpNeighborState.getSupportedCapabilities()
.- Returns:
- current value
-
setSessionState
public State8Builder setSessionState(BgpNeighborState.SessionState value)
Set the property corresponding toBgpNeighborState.getSessionState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSupportedCapabilities
public State8Builder setSupportedCapabilities(Set<Class<? extends BgpCapability>> values)
Set the property corresponding toBgpNeighborState.getSupportedCapabilities()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
-