Class TunnelBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelBuilder
Class that builds
Tunnel
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:
Tunnel createTunnel(int fooXyzzy, int barBaz) {
return new TunnelBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Tunnel, 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.TunnelBuilder
(Tunnel base) Construct a builder initialized with state from specifiedTunnel
.Construct a new builder initialized from specifiedTunnelTypeAttributes
. -
Method Summary
Modifier and TypeMethodDescription@NonNull Tunnel
build()
A newTunnel
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toTunnelTypeAttributes.getTunnelType()
.setTunnelType
(TunnelTypeBase value) Set the property corresponding toTunnelTypeAttributes.getTunnelType()
to the specified value.
-
Constructor Details
-
TunnelBuilder
public TunnelBuilder()Construct an empty builder. -
TunnelBuilder
Construct a new builder initialized from specifiedTunnelTypeAttributes
.- Parameters:
arg
- TunnelTypeAttributes from which the builder should be initialized
-
TunnelBuilder
Construct a builder initialized with state from specifiedTunnel
.- Parameters:
base
- Tunnel from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getTunnelType
Return current value associated with the property corresponding toTunnelTypeAttributes.getTunnelType()
.- Returns:
- current value
-
setTunnelType
Set the property corresponding toTunnelTypeAttributes.getTunnelType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newTunnel
instance.- Returns:
- A new
Tunnel
instance.
-