Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.sr.rev130819
Class PathTypes1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.sr.rev130819.PathTypes1Builder
-
@Generated("mdsal-binding-generator") public class PathTypes1Builder extends Object
Class that buildsPathTypes1
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:
PathTypes1 createPathTypes1(int fooXyzzy, int barBaz) { return new PathTypes1Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathTypes1, 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:
PathTypes1
- 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
-
-
Constructor Summary
Constructors Constructor Description PathTypes1Builder()
Construct an empty builder.PathTypes1Builder(PathTypes1 base)
Construct a builder initialized with state from specifiedPathTypes1
.PathTypes1Builder(TunnelSrType arg)
Construct a new builder initialized from specifiedTunnelSrType
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull PathTypes1
build()
A newPathTypes1
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.SrTunnel
getSrTunnel()
Return current value associated with the property corresponding toTunnelSrType.getSrTunnel()
.PathTypes1Builder
setSrTunnel(SrTunnel value)
Set the property corresponding toTunnelSrType.getSrTunnel()
to the specified value.
-
-
-
Constructor Detail
-
PathTypes1Builder
public PathTypes1Builder()
Construct an empty builder.
-
PathTypes1Builder
public PathTypes1Builder(TunnelSrType arg)
Construct a new builder initialized from specifiedTunnelSrType
.- Parameters:
arg
- TunnelSrType from which the builder should be initialized
-
PathTypes1Builder
public PathTypes1Builder(PathTypes1 base)
Construct a builder initialized with state from specifiedPathTypes1
.- Parameters:
base
- PathTypes1 from which the builder should be initialized
-
-
Method Detail
-
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
-
getSrTunnel
public SrTunnel getSrTunnel()
Return current value associated with the property corresponding toTunnelSrType.getSrTunnel()
.- Returns:
- current value
-
setSrTunnel
public PathTypes1Builder setSrTunnel(SrTunnel value)
Set the property corresponding toTunnelSrType.getSrTunnel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
public @NonNull PathTypes1 build()
A newPathTypes1
instance.- Returns:
- A new
PathTypes1
instance.
-
-