Class GnmiTopologyTypesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.GnmiTopologyTypesBuilder
Class that builds
GnmiTopologyTypes 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:
GnmiTopologyTypes createGnmiTopologyTypes(int fooXyzzy, int barBaz) {
return new GnmiTopologyTypesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of GnmiTopologyTypes, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedGnmiTopologyTypes. -
Method Summary
Modifier and TypeMethodDescription@NonNull GnmiTopologyTypesbuild()A newGnmiTopologyTypesinstance.Return current value associated with the property corresponding toGnmiTopologyTypes.getGnmiTopology().setGnmiTopology(GnmiTopology value) Set the property corresponding toGnmiTopologyTypes.getGnmiTopology()to the specified value.
-
Constructor Details
-
GnmiTopologyTypesBuilder
public GnmiTopologyTypesBuilder()Construct an empty builder. -
GnmiTopologyTypesBuilder
Construct a builder initialized with state from specifiedGnmiTopologyTypes.- Parameters:
base- GnmiTopologyTypes from which the builder should be initialized
-
-
Method Details
-
getGnmiTopology
Return current value associated with the property corresponding toGnmiTopologyTypes.getGnmiTopology().- Returns:
- current value
-
setGnmiTopology
Set the property corresponding toGnmiTopologyTypes.getGnmiTopology()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
A newGnmiTopologyTypesinstance.- Returns:
- A new
GnmiTopologyTypesinstance.
-