Class TunnelSourceParametersBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelSourceParametersBuilder
Class that builds
TunnelSourceParameters
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:
TunnelSourceParameters createTunnelSourceParameters(int fooXyzzy, int barBaz) {
return new TunnelSourceParametersBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of TunnelSourceParameters, 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 new builder initialized from specifiedIpPortLocator
.Construct a builder initialized with state from specifiedTunnelSourceParameters
. -
Method Summary
Modifier and TypeMethodDescription@NonNull TunnelSourceParameters
build()
A newTunnelSourceParameters
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getIp()
Return current value associated with the property corresponding toIpPortLocator.getIp()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getPort()
Return current value associated with the property corresponding toIpPortLocator.getPort()
.setIp
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value) Set the property corresponding toIpPortLocator.getIp()
to the specified value.setPort
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toIpPortLocator.getPort()
to the specified value.
-
Constructor Details
-
TunnelSourceParametersBuilder
public TunnelSourceParametersBuilder()Construct an empty builder. -
TunnelSourceParametersBuilder
Construct a new builder initialized from specifiedIpPortLocator
.- Parameters:
arg
- IpPortLocator from which the builder should be initialized
-
TunnelSourceParametersBuilder
Construct a builder initialized with state from specifiedTunnelSourceParameters
.- Parameters:
base
- TunnelSourceParameters 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
-
getIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIp()Return current value associated with the property corresponding toIpPortLocator.getIp()
.- Returns:
- current value
-
getPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()Return current value associated with the property corresponding toIpPortLocator.getPort()
.- Returns:
- current value
-
setIp
public TunnelSourceParametersBuilder setIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value) Set the property corresponding toIpPortLocator.getIp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPort
public TunnelSourceParametersBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toIpPortLocator.getPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newTunnelSourceParameters
instance.- Returns:
- A new
TunnelSourceParameters
instance.
-