Class Tlvs3Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev200720.Tlvs3Builder
Class that builds
Tlvs3
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:
Tlvs3 createTlvs3(int fooXyzzy, int barBaz) {
return new Tlvs3Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Tlvs3, 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 specifiedLspDbVersionTlv
.Construct a new builder initialized from specifiedSpeakerEntityIdTlv
.Tlvs3Builder
(Tlvs3 base) Construct a builder initialized with state from specifiedTlvs3
. -
Method Summary
Modifier and TypeMethodDescription@NonNull Tlvs3
build()
A newTlvs3
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLspDbVersionTlv.getLspDbVersion()
.Return current value associated with the property corresponding toSpeakerEntityIdTlv.getSpeakerEntityId()
.setLspDbVersion
(LspDbVersion value) Set the property corresponding toLspDbVersionTlv.getLspDbVersion()
to the specified value.Set the property corresponding toSpeakerEntityIdTlv.getSpeakerEntityId()
to the specified value.
-
Constructor Details
-
Tlvs3Builder
public Tlvs3Builder()Construct an empty builder. -
Tlvs3Builder
Construct a new builder initialized from specifiedLspDbVersionTlv
.- Parameters:
arg
- LspDbVersionTlv from which the builder should be initialized
-
Tlvs3Builder
Construct a new builder initialized from specifiedSpeakerEntityIdTlv
.- Parameters:
arg
- SpeakerEntityIdTlv from which the builder should be initialized
-
Tlvs3Builder
Construct a builder initialized with state from specifiedTlvs3
.- Parameters:
base
- Tlvs3 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
-
getLspDbVersion
Return current value associated with the property corresponding toLspDbVersionTlv.getLspDbVersion()
.- Returns:
- current value
-
getSpeakerEntityId
Return current value associated with the property corresponding toSpeakerEntityIdTlv.getSpeakerEntityId()
.- Returns:
- current value
-
setLspDbVersion
Set the property corresponding toLspDbVersionTlv.getLspDbVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSpeakerEntityId
Set the property corresponding toSpeakerEntityIdTlv.getSpeakerEntityId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newTlvs3
instance.- Returns:
- A new
Tlvs3
instance.
-