Class State12Builder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State12Builder
Class that builds
State12
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:
State12 createState12(int fooXyzzy, int barBaz) {
return new State12Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of State12, 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 specifiedBgpPeerGroupPeerGroupNameConfig
.State12Builder
(State12 base) Construct a builder initialized with state from specifiedState12
. -
Method Summary
Modifier and TypeMethodDescription@NonNull State12
build()
A newState12
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBgpPeerGroupPeerGroupNameConfig.getPeerGroupName()
.setPeerGroupName
(String value) Set the property corresponding toBgpPeerGroupPeerGroupNameConfig.getPeerGroupName()
to the specified value.
-
Constructor Details
-
State12Builder
public State12Builder()Construct an empty builder. -
State12Builder
Construct a new builder initialized from specifiedBgpPeerGroupPeerGroupNameConfig
.- Parameters:
arg
- BgpPeerGroupPeerGroupNameConfig from which the builder should be initialized
-
State12Builder
Construct a builder initialized with state from specifiedState12
.- Parameters:
base
- State12 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
-
getPeerGroupName
Return current value associated with the property corresponding toBgpPeerGroupPeerGroupNameConfig.getPeerGroupName()
.- Returns:
- current value
-
setPeerGroupName
Set the property corresponding toBgpPeerGroupPeerGroupNameConfig.getPeerGroupName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newState12
instance.- Returns:
- A new
State12
instance.
-