Class GlobalConfigAugmentationBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instance.protocol.GlobalConfigAugmentationBuilder
Class that builds
GlobalConfigAugmentation
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:
GlobalConfigAugmentation createGlobalConfigAugmentation(int fooXyzzy, int barBaz) {
return new GlobalConfigAugmentationBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of GlobalConfigAugmentation, 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 specifiedGlobalConfigAugmentation
. -
Method Summary
Modifier and TypeMethodDescription@NonNull GlobalConfigAugmentation
build()
A newGlobalConfigAugmentation
instance.Return current value associated with the property corresponding toGlobalConfigAugmentation.getRouteReflectorClusterId()
.Set the property corresponding toGlobalConfigAugmentation.getRouteReflectorClusterId()
to the specified value.
-
Constructor Details
-
GlobalConfigAugmentationBuilder
public GlobalConfigAugmentationBuilder()Construct an empty builder. -
GlobalConfigAugmentationBuilder
Construct a builder initialized with state from specifiedGlobalConfigAugmentation
.- Parameters:
base
- GlobalConfigAugmentation from which the builder should be initialized
-
-
Method Details
-
getRouteReflectorClusterId
Return current value associated with the property corresponding toGlobalConfigAugmentation.getRouteReflectorClusterId()
.- Returns:
- current value
-
setRouteReflectorClusterId
Set the property corresponding toGlobalConfigAugmentation.getRouteReflectorClusterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newGlobalConfigAugmentation
instance.- Returns:
- A new
GlobalConfigAugmentation
instance.
-