Class State5Builder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State5Builder
Class that builds
State5
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:
State5 createState5(int fooXyzzy, int barBaz) {
return new State5Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of State5, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedBgpAfiSafiGracefulRestartState
.State5Builder
(State5 base) Construct a builder initialized with state from specifiedState5
. -
Method Summary
Modifier and TypeMethodDescription@NonNull State5
build()
A newState5
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBgpAfiSafiGracefulRestartState.getLocalRestarting()
.getMode()
Return current value associated with the property corresponding toBgpAfiSafiGracefulRestartState.getMode()
.Return current value associated with the property corresponding toBgpAfiSafiGracefulRestartState.getPeerRestarting()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toBgpAfiSafiGracefulRestartState.getPeerRestartTime()
.setLocalRestarting
(Boolean value) Set the property corresponding toBgpAfiSafiGracefulRestartState.getLocalRestarting()
to the specified value.Set the property corresponding toBgpAfiSafiGracefulRestartState.getMode()
to the specified value.setPeerRestarting
(Boolean value) Set the property corresponding toBgpAfiSafiGracefulRestartState.getPeerRestarting()
to the specified value.setPeerRestartTime
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toBgpAfiSafiGracefulRestartState.getPeerRestartTime()
to the specified value.
-
Constructor Details
-
State5Builder
public State5Builder()Construct an empty builder. -
State5Builder
Construct a new builder initialized from specifiedBgpAfiSafiGracefulRestartState
.- Parameters:
arg
- BgpAfiSafiGracefulRestartState from which the builder should be initialized
-
State5Builder
Construct a builder initialized with state from specifiedState5
.- Parameters:
base
- State5 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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLocalRestarting
Return current value associated with the property corresponding toBgpAfiSafiGracefulRestartState.getLocalRestarting()
.- Returns:
- current value
-
getMode
Return current value associated with the property corresponding toBgpAfiSafiGracefulRestartState.getMode()
.- Returns:
- current value
-
getPeerRestartTime
public org.opendaylight.yangtools.yang.common.Uint16 getPeerRestartTime()Return current value associated with the property corresponding toBgpAfiSafiGracefulRestartState.getPeerRestartTime()
.- Returns:
- current value
-
getPeerRestarting
Return current value associated with the property corresponding toBgpAfiSafiGracefulRestartState.getPeerRestarting()
.- Returns:
- current value
-
setLocalRestarting
Set the property corresponding toBgpAfiSafiGracefulRestartState.getLocalRestarting()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMode
Set the property corresponding toBgpAfiSafiGracefulRestartState.getMode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerRestartTime
Set the property corresponding toBgpAfiSafiGracefulRestartState.getPeerRestartTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerRestarting
Set the property corresponding toBgpAfiSafiGracefulRestartState.getPeerRestarting()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newState5
instance.- Returns:
- A new
State5
instance.
-