Class Node1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.sr.rev130819.Node1Builder
Class that builds
Node1
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:
Node1 createNode1(int fooXyzzy, int barBaz) {
return new Node1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Node1, 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.Node1Builder
(Node1 base) Construct a builder initialized with state from specifiedNode1
.Construct a new builder initialized from specifiedSrNodeAttributes
. -
Method Summary
Modifier and TypeMethodDescription@NonNull Node1
build()
A newNode1
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toSrNodeAttributes.getSegments()
.setSegments
(Map<SegmentsKey, Segments> values) Set the property corresponding toSrNodeAttributes.getSegments()
to the specified value.
-
Constructor Details
-
Node1Builder
public Node1Builder()Construct an empty builder. -
Node1Builder
Construct a new builder initialized from specifiedSrNodeAttributes
.- Parameters:
arg
- SrNodeAttributes from which the builder should be initialized
-
Node1Builder
Construct a builder initialized with state from specifiedNode1
.- Parameters:
base
- Node1 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
-
getSegments
Return current value associated with the property corresponding toSrNodeAttributes.getSegments()
.- Returns:
- current value
-
setSegments
Set the property corresponding toSrNodeAttributes.getSegments()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
build
A newNode1
instance.- Returns:
- A new
Node1
instance.
-