Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.initiated.rev200720
Class Stateful2Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.initiated.rev200720.Stateful2Builder
Class that builds
Stateful2
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:
Stateful2 createStateful2(int fooXyzzy, int barBaz) {
return new Stateful2Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Stateful2, 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 specifiedInitiatedCapabilityTlv
.Stateful2Builder
(Stateful2 base) Construct a builder initialized with state from specifiedStateful2
. -
Method Summary
Modifier and TypeMethodDescription@NonNull Stateful2
build()
A newStateful2
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toInitiatedCapabilityTlv.getInitiation()
.setInitiation
(Boolean value) Set the property corresponding toInitiatedCapabilityTlv.getInitiation()
to the specified value.
-
Constructor Details
-
Stateful2Builder
public Stateful2Builder()Construct an empty builder. -
Stateful2Builder
Construct a new builder initialized from specifiedInitiatedCapabilityTlv
.- Parameters:
arg
- InitiatedCapabilityTlv from which the builder should be initialized
-
Stateful2Builder
Construct a builder initialized with state from specifiedStateful2
.- Parameters:
base
- Stateful2 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
-
getInitiation
Return current value associated with the property corresponding toInitiatedCapabilityTlv.getInitiation()
.- Returns:
- current value
-
setInitiation
Set the property corresponding toInitiatedCapabilityTlv.getInitiation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newStateful2
instance.- Returns:
- A new
Stateful2
instance.
-