Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.initiated.rev200720
Class Srp2Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.initiated.rev200720.Srp2Builder
Class that builds
Srp2
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:
Srp2 createSrp2(int fooXyzzy, int barBaz) {
return new Srp2Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Srp2, 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.Srp2Builder
(Srp2 base) Construct a builder initialized with state from specifiedSrp2
. -
Method Summary
Modifier and TypeMethodDescription@NonNull Srp2
build()
A newSrp2
instance.Return current value associated with the property corresponding toSrp2.getRemove()
.Set the property corresponding toSrp2.getRemove()
to the specified value.
-
Constructor Details
-
Srp2Builder
public Srp2Builder()Construct an empty builder. -
Srp2Builder
Construct a builder initialized with state from specifiedSrp2
.- Parameters:
base
- Srp2 from which the builder should be initialized
-
-
Method Details
-
getRemove
Return current value associated with the property corresponding toSrp2.getRemove()
.- Returns:
- current value
-
setRemove
Set the property corresponding toSrp2.getRemove()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newSrp2
instance.- Returns:
- A new
Srp2
instance.
-