Class TlvsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.object.lsp.TlvsBuilder
Class that builds
Tlvs
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:
Tlvs createTlvs(int fooXyzzy, int barBaz) {
return new TlvsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Tlvs, 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
ConstructorsConstructorDescriptionConstruct an empty builder.TlvsBuilder
(Tlvs base) Construct a builder initialized with state from specifiedTlvs
.Construct a new builder initialized from specifiedLspErrorCodeTlv
.Construct a new builder initialized from specifiedLspIdentifiersTlv
.Construct a new builder initialized from specifiedPathBindingTlv
.Construct a new builder initialized from specifiedRsvpErrorSpecTlv
.Construct a new builder initialized from specifiedSymbolicPathNameTlv
.Construct a new builder initialized from specifiedVendorInformationTlvs
.TlvsBuilder
(VsTlv arg) Construct a new builder initialized from specifiedVsTlv
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Tlvs> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<Tlvs>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Tlvs
build()
A newTlvs
instance.static @NonNull Tlvs
empty()
Get empty instance of Tlvs.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLspErrorCodeTlv.getLspErrorCode()
.Return current value associated with the property corresponding toLspIdentifiersTlv.getLspIdentifiers()
.Return current value associated with the property corresponding toPathBindingTlv.getPathBinding()
.Return current value associated with the property corresponding toRsvpErrorSpecTlv.getRsvpErrorSpec()
.Return current value associated with the property corresponding toSymbolicPathNameTlv.getSymbolicPathName()
.Return current value associated with the property corresponding toVendorInformationTlvs.getVendorInformationTlv()
.getVsTlv()
Return current value associated with the property corresponding toVsTlv.getVsTlv()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Tlvs>> augmentationType) Remove an augmentation from this builder's product.setLspErrorCode
(LspErrorCode value) Set the property corresponding toLspErrorCodeTlv.getLspErrorCode()
to the specified value.setLspIdentifiers
(LspIdentifiers value) Set the property corresponding toLspIdentifiersTlv.getLspIdentifiers()
to the specified value.setPathBinding
(PathBinding value) Set the property corresponding toPathBindingTlv.getPathBinding()
to the specified value.setRsvpErrorSpec
(RsvpErrorSpec value) Set the property corresponding toRsvpErrorSpecTlv.getRsvpErrorSpec()
to the specified value.Set the property corresponding toSymbolicPathNameTlv.getSymbolicPathName()
to the specified value.Set the property corresponding toVendorInformationTlvs.getVendorInformationTlv()
to the specified value.Set the property corresponding toVsTlv.getVsTlv()
to the specified value.
-
Constructor Details
-
TlvsBuilder
public TlvsBuilder()Construct an empty builder. -
TlvsBuilder
Construct a new builder initialized from specifiedLspErrorCodeTlv
.- Parameters:
arg
- LspErrorCodeTlv from which the builder should be initialized
-
TlvsBuilder
Construct a new builder initialized from specifiedLspIdentifiersTlv
.- Parameters:
arg
- LspIdentifiersTlv from which the builder should be initialized
-
TlvsBuilder
Construct a new builder initialized from specifiedRsvpErrorSpecTlv
.- Parameters:
arg
- RsvpErrorSpecTlv from which the builder should be initialized
-
TlvsBuilder
Construct a new builder initialized from specifiedSymbolicPathNameTlv
.- Parameters:
arg
- SymbolicPathNameTlv from which the builder should be initialized
-
TlvsBuilder
Construct a new builder initialized from specifiedVsTlv
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.VsTlv from which the builder should be initialized
-
TlvsBuilder
Construct a new builder initialized from specifiedVendorInformationTlvs
.- Parameters:
arg
- VendorInformationTlvs from which the builder should be initialized
-
TlvsBuilder
Construct a new builder initialized from specifiedPathBindingTlv
.- Parameters:
arg
- PathBindingTlv from which the builder should be initialized
-
TlvsBuilder
Construct a builder initialized with state from specifiedTlvs
.- Parameters:
base
- Tlvs 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
-
empty
Get empty instance of Tlvs.- Returns:
- An empty
Tlvs
-
getLspErrorCode
Return current value associated with the property corresponding toLspErrorCodeTlv.getLspErrorCode()
.- Returns:
- current value
-
getLspIdentifiers
Return current value associated with the property corresponding toLspIdentifiersTlv.getLspIdentifiers()
.- Returns:
- current value
-
getPathBinding
Return current value associated with the property corresponding toPathBindingTlv.getPathBinding()
.- Returns:
- current value
-
getRsvpErrorSpec
Return current value associated with the property corresponding toRsvpErrorSpecTlv.getRsvpErrorSpec()
.- Returns:
- current value
-
getSymbolicPathName
Return current value associated with the property corresponding toSymbolicPathNameTlv.getSymbolicPathName()
.- Returns:
- current value
-
getVendorInformationTlv
Return current value associated with the property corresponding toVendorInformationTlvs.getVendorInformationTlv()
.- Returns:
- current value
-
getVsTlv
Return current value associated with the property corresponding toVsTlv.getVsTlv()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<Tlvs>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setLspErrorCode
Set the property corresponding toLspErrorCodeTlv.getLspErrorCode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspIdentifiers
Set the property corresponding toLspIdentifiersTlv.getLspIdentifiers()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathBinding
Set the property corresponding toPathBindingTlv.getPathBinding()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRsvpErrorSpec
Set the property corresponding toRsvpErrorSpecTlv.getRsvpErrorSpec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSymbolicPathName
Set the property corresponding toSymbolicPathNameTlv.getSymbolicPathName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVendorInformationTlv
Set the property corresponding toVendorInformationTlvs.getVendorInformationTlv()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setVsTlv
Set the property corresponding toVsTlv.getVsTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TlvsBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<Tlvs> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public TlvsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Tlvs>> augmentationType) Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
A newTlvs
instance.- Returns:
- A new
Tlvs
instance.
-