Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021
Class TerminationPoint1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.TerminationPoint1Builder
Class that builds
TerminationPoint1
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:
TerminationPoint1 createTerminationPoint1(int fooXyzzy, int barBaz) {
return new TerminationPoint1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of TerminationPoint1, 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 new builder initialized from specifiedIgpTerminationPointAttributes
.Construct a builder initialized with state from specifiedTerminationPoint1
. -
Method Summary
Modifier and TypeMethodDescription@NonNull TerminationPoint1
build()
A newTerminationPoint1
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toIgpTerminationPointAttributes.getIgpTerminationPointAttributes()
.Set the property corresponding toIgpTerminationPointAttributes.getIgpTerminationPointAttributes()
to the specified value.
-
Constructor Details
-
TerminationPoint1Builder
public TerminationPoint1Builder()Construct an empty builder. -
TerminationPoint1Builder
Construct a new builder initialized from specifiedIgpTerminationPointAttributes
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.IgpTerminationPointAttributes from which the builder should be initialized
-
TerminationPoint1Builder
Construct a builder initialized with state from specifiedTerminationPoint1
.- Parameters:
base
- TerminationPoint1 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
-
getIgpTerminationPointAttributes
Return current value associated with the property corresponding toIgpTerminationPointAttributes.getIgpTerminationPointAttributes()
.- Returns:
- current value
-
setIgpTerminationPointAttributes
public TerminationPoint1Builder setIgpTerminationPointAttributes(IgpTerminationPointAttributes value) Set the property corresponding toIgpTerminationPointAttributes.getIgpTerminationPointAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newTerminationPoint1
instance.- Returns:
- A new
TerminationPoint1
instance.
-