Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819
Class Paths1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.Paths1Builder
Class that builds
Paths1
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:
Paths1 createPaths1(int fooXyzzy, int barBaz) {
return new Paths1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Paths1, 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.Paths1Builder
(Paths1 base) Construct a builder initialized with state from specifiedPaths1
.Construct a new builder initialized from specifiedTunnelP2pPathCfgAttributes
.Construct a new builder initialized from specifiedTunnelP2pPathOperAttributes
. -
Method Summary
Modifier and TypeMethodDescription@NonNull Paths1
build()
A newPaths1
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toTunnelP2pPathCfgAttributes.getExplicitHops()
.Return current value associated with the property corresponding toTunnelP2pPathOperAttributes.getReportedHops()
.setExplicitHops
(Map<ExplicitHopsKey, ExplicitHops> values) Set the property corresponding toTunnelP2pPathCfgAttributes.getExplicitHops()
to the specified value.setReportedHops
(Map<ReportedHopsKey, ReportedHops> values) Set the property corresponding toTunnelP2pPathOperAttributes.getReportedHops()
to the specified value.
-
Constructor Details
-
Paths1Builder
public Paths1Builder()Construct an empty builder. -
Paths1Builder
Construct a new builder initialized from specifiedTunnelP2pPathCfgAttributes
.- Parameters:
arg
- TunnelP2pPathCfgAttributes from which the builder should be initialized
-
Paths1Builder
Construct a new builder initialized from specifiedTunnelP2pPathOperAttributes
.- Parameters:
arg
- TunnelP2pPathOperAttributes from which the builder should be initialized
-
Paths1Builder
Construct a builder initialized with state from specifiedPaths1
.- Parameters:
base
- Paths1 from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
getExplicitHops
Return current value associated with the property corresponding toTunnelP2pPathCfgAttributes.getExplicitHops()
.- Returns:
- current value
-
getReportedHops
Return current value associated with the property corresponding toTunnelP2pPathOperAttributes.getReportedHops()
.- Returns:
- current value
-
setExplicitHops
Set the property corresponding toTunnelP2pPathCfgAttributes.getExplicitHops()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setReportedHops
Set the property corresponding toTunnelP2pPathOperAttributes.getReportedHops()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
build
A newPaths1
instance.- Returns:
- A new
Paths1
instance.
-