Class SupportedTunnelsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.SupportedTunnelsBuilder
Class that builds
SupportedTunnels
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:
SupportedTunnels createSupportedTunnels(int fooXyzzy, int barBaz) {
return new SupportedTunnelsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SupportedTunnels, 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 specifiedSupportedTunnels
. -
Method Summary
Modifier and TypeMethodDescription@NonNull SupportedTunnels
build()
A newSupportedTunnels
instance.Return current value associated with the property corresponding toSupportedTunnels.getSupportedTunnelEntry()
.Set the property corresponding toSupportedTunnels.getSupportedTunnelEntry()
to the specified value.
-
Constructor Details
-
SupportedTunnelsBuilder
public SupportedTunnelsBuilder()Construct an empty builder. -
SupportedTunnelsBuilder
Construct a builder initialized with state from specifiedSupportedTunnels
.- Parameters:
base
- SupportedTunnels from which the builder should be initialized
-
-
Method Details
-
getSupportedTunnelEntry
Return current value associated with the property corresponding toSupportedTunnels.getSupportedTunnelEntry()
.- Returns:
- current value
-
setSupportedTunnelEntry
Set the property corresponding toSupportedTunnels.getSupportedTunnelEntry()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
build
A newSupportedTunnels
instance.- Returns:
- A new
SupportedTunnels
instance.
-