Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109
Class SupportingNode1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109.SupportingNode1Builder
Class that builds
SupportingNode1
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:
SupportingNode1 createSupportingNode1(int fooXyzzy, int barBaz) {
return new SupportingNode1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SupportingNode1, 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 specifiedSupportingNode1
.Construct a new builder initialized from specifiedTunnelPcepSupportingNodeAttributes
. -
Method Summary
Modifier and TypeMethodDescription@NonNull SupportingNode1
build()
A newSupportingNode1
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toTunnelPcepSupportingNodeAttributes.getPathComputationClient()
.Set the property corresponding toTunnelPcepSupportingNodeAttributes.getPathComputationClient()
to the specified value.
-
Constructor Details
-
SupportingNode1Builder
public SupportingNode1Builder()Construct an empty builder. -
SupportingNode1Builder
Construct a new builder initialized from specifiedTunnelPcepSupportingNodeAttributes
.- Parameters:
arg
- TunnelPcepSupportingNodeAttributes from which the builder should be initialized
-
SupportingNode1Builder
Construct a builder initialized with state from specifiedSupportingNode1
.- Parameters:
base
- SupportingNode1 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
-
getPathComputationClient
Return current value associated with the property corresponding toTunnelPcepSupportingNodeAttributes.getPathComputationClient()
.- Returns:
- current value
-
setPathComputationClient
Set the property corresponding toTunnelPcepSupportingNodeAttributes.getPathComputationClient()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newSupportingNode1
instance.- Returns:
- A new
SupportingNode1
instance.
-