Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.initiation
Class TlvsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.initiation.TlvsBuilder
-
@Generated("mdsal-binding-generator") public class TlvsBuilder extends Object
Class that buildsTlvs
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:
Tlvs
- 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
-
-
Constructor Summary
Constructors Constructor Description TlvsBuilder()
Construct an empty builder.TlvsBuilder(DescriptionTlv arg)
Construct a new builder initialized from specifiedDescriptionTlv
.TlvsBuilder(Tlvs base)
Construct a builder initialized with state from specifiedTlvs
.TlvsBuilder(InitiationTlvs arg)
Construct a new builder initialized from specifiedInitiationTlvs
.TlvsBuilder(NameTlv arg)
Construct a new builder initialized from specifiedNameTlv
.TlvsBuilder(StringInformations arg)
Construct a new builder initialized from specifiedStringInformations
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TlvsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.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.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.DescriptionTlv
getDescriptionTlv()
Return current value associated with the property corresponding toDescriptionTlv.getDescriptionTlv()
.NameTlv
getNameTlv()
Return current value associated with the property corresponding toNameTlv.getNameTlv()
.List<StringInformation>
getStringInformation()
Return current value associated with the property corresponding toStringInformations.getStringInformation()
.TlvsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>> augmentationType)
Remove an augmentation from this builder's product.TlvsBuilder
setDescriptionTlv(DescriptionTlv value)
Set the property corresponding toDescriptionTlv.getDescriptionTlv()
to the specified value.TlvsBuilder
setNameTlv(NameTlv value)
Set the property corresponding toNameTlv.getNameTlv()
to the specified value.TlvsBuilder
setStringInformation(List<StringInformation> values)
Set the property corresponding toStringInformations.getStringInformation()
to the specified value.
-
-
-
Constructor Detail
-
TlvsBuilder
public TlvsBuilder()
Construct an empty builder.
-
TlvsBuilder
public TlvsBuilder(InitiationTlvs arg)
Construct a new builder initialized from specifiedInitiationTlvs
.- Parameters:
arg
- InitiationTlvs from which the builder should be initialized
-
TlvsBuilder
public TlvsBuilder(StringInformations arg)
Construct a new builder initialized from specifiedStringInformations
.- Parameters:
arg
- StringInformations from which the builder should be initialized
-
TlvsBuilder
public TlvsBuilder(DescriptionTlv arg)
Construct a new builder initialized from specifiedDescriptionTlv
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.DescriptionTlv from which the builder should be initialized
-
TlvsBuilder
public TlvsBuilder(NameTlv arg)
Construct a new builder initialized from specifiedNameTlv
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.NameTlv from which the builder should be initialized
-
-
Method Detail
-
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
-
getDescriptionTlv
public DescriptionTlv getDescriptionTlv()
Return current value associated with the property corresponding toDescriptionTlv.getDescriptionTlv()
.- Returns:
- current value
-
getNameTlv
public NameTlv getNameTlv()
Return current value associated with the property corresponding toNameTlv.getNameTlv()
.- Returns:
- current value
-
getStringInformation
public List<StringInformation> getStringInformation()
Return current value associated with the property corresponding toStringInformations.getStringInformation()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.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
-
setDescriptionTlv
public TlvsBuilder setDescriptionTlv(DescriptionTlv value)
Set the property corresponding toDescriptionTlv.getDescriptionTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNameTlv
public TlvsBuilder setNameTlv(NameTlv value)
Set the property corresponding toNameTlv.getNameTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStringInformation
public TlvsBuilder setStringInformation(List<StringInformation> values)
Set the property corresponding toStringInformations.getStringInformation()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public TlvsBuilder addAugmentation(org.opendaylight.yangtools.yang.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.yang.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
-
-