Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120
Class BgpRoleSetsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.BgpRoleSetsBuilder
Class that builds
BgpRoleSets
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:
BgpRoleSets createBgpRoleSets(int fooXyzzy, int barBaz) {
return new BgpRoleSetsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of BgpRoleSets, 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 builder initialized with state from specifiedBgpRoleSets
. -
Method Summary
Modifier and TypeMethodDescription@NonNull BgpRoleSets
build()
A newBgpRoleSets
instance.Return current value associated with the property corresponding toBgpRoleSets.getRoleSets()
.setRoleSets
(RoleSets value) Set the property corresponding toBgpRoleSets.getRoleSets()
to the specified value.
-
Constructor Details
-
BgpRoleSetsBuilder
public BgpRoleSetsBuilder()Construct an empty builder. -
BgpRoleSetsBuilder
Construct a builder initialized with state from specifiedBgpRoleSets
.- Parameters:
base
- BgpRoleSets from which the builder should be initialized
-
-
Method Details
-
getRoleSets
Return current value associated with the property corresponding toBgpRoleSets.getRoleSets()
.- Returns:
- current value
-
setRoleSets
Set the property corresponding toBgpRoleSets.getRoleSets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newBgpRoleSets
instance.- Returns:
- A new
BgpRoleSets
instance.
-