Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vs.tlv
Class VsTlvBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vs.tlv.VsTlvBuilder
@Deprecated(forRemoval=true)
@Generated("mdsal-binding-generator")
public class VsTlvBuilder
extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Class that builds
VsTlv
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:
VsTlv createVsTlv(int fooXyzzy, int barBaz) {
return new VsTlvBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of VsTlv, 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
ConstructorsConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version.Construct an empty builder.VsTlvBuilder
(VsTlv base) Deprecated, for removal: This API element is subject to removal in a future version.Construct a builder initialized with state from specifiedVsTlv
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<VsTlv> augmentation) Deprecated, for removal: This API element is subject to removal in a future version.Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<VsTlv>>
E$$augmentation
(Class<E$$> augmentationType) Deprecated, for removal: This API element is subject to removal in a future version.Return the specified augmentation, if it is present in this builder.@NonNull VsTlv
build()
Deprecated, for removal: This API element is subject to removal in a future version.A newVsTlv
instance.static @NonNull VsTlv
empty()
Deprecated, for removal: This API element is subject to removal in a future version.Get empty instance of VsTlv.Deprecated, for removal: This API element is subject to removal in a future version.Return current value associated with the property corresponding toVsTlv.getEnterpriseNumber()
.Deprecated, for removal: This API element is subject to removal in a future version.Return current value associated with the property corresponding toVsTlv.getVendorPayload()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<VsTlv>> augmentationType) Deprecated, for removal: This API element is subject to removal in a future version.Remove an augmentation from this builder's product.Deprecated, for removal: This API element is subject to removal in a future version.Set the property corresponding toVsTlv.getEnterpriseNumber()
to the specified value.setVendorPayload
(VendorPayload value) Deprecated, for removal: This API element is subject to removal in a future version.Set the property corresponding toVsTlv.getVendorPayload()
to the specified value.
-
Constructor Details
-
VsTlvBuilder
public VsTlvBuilder()Deprecated, for removal: This API element is subject to removal in a future version.Construct an empty builder. -
VsTlvBuilder
Deprecated, for removal: This API element is subject to removal in a future version.Construct a builder initialized with state from specifiedVsTlv
.- Parameters:
base
- VsTlv from which the builder should be initialized
-
-
Method Details
-
empty
Deprecated, for removal: This API element is subject to removal in a future version.Get empty instance of VsTlv.- Returns:
- An empty
VsTlv
-
getEnterpriseNumber
Deprecated, for removal: This API element is subject to removal in a future version.Return current value associated with the property corresponding toVsTlv.getEnterpriseNumber()
.- Returns:
- current value
-
getVendorPayload
Deprecated, for removal: This API element is subject to removal in a future version.Return current value associated with the property corresponding toVsTlv.getVendorPayload()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<VsTlv>> E$$ augmentation(Class<E$$> augmentationType) Deprecated, for removal: This API element is subject to removal in a future version.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
-
setEnterpriseNumber
Deprecated, for removal: This API element is subject to removal in a future version.Set the property corresponding toVsTlv.getEnterpriseNumber()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVendorPayload
Deprecated, for removal: This API element is subject to removal in a future version.Set the property corresponding toVsTlv.getVendorPayload()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public VsTlvBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<VsTlv> augmentation) Deprecated, for removal: This API element is subject to removal in a future version.Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public VsTlvBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<VsTlv>> augmentationType) Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.A newVsTlv
instance.- Returns:
- A new
VsTlv
instance.
-