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