Class DescriptionTlvBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.description.tlv.DescriptionTlvBuilder
-
@Generated("mdsal-binding-generator") public class DescriptionTlvBuilder extends Object
Class that buildsDescriptionTlv
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:
DescriptionTlv createDescriptionTlv(int fooXyzzy, int barBaz) { return new DescriptionTlvBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DescriptionTlv, 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:
DescriptionTlv
- 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 DescriptionTlvBuilder()
Construct an empty builder.DescriptionTlvBuilder(DescriptionTlv base)
Construct a builder initialized with state from specifiedDescriptionTlv
.DescriptionTlvBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescriptionTlvBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DescriptionTlv> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DescriptionTlv>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DescriptionTlv
build()
A newDescriptionTlv
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getDescription()
Return current value associated with the property corresponding toDescriptionTlv.getDescription()
.DescriptionTlvBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DescriptionTlv>> augmentationType)
Remove an augmentation from this builder's product.DescriptionTlvBuilder
setDescription(String value)
Set the property corresponding toDescriptionTlv.getDescription()
to the specified value.
-
-
-
Constructor Detail
-
DescriptionTlvBuilder
public DescriptionTlvBuilder()
Construct an empty builder.
-
DescriptionTlvBuilder
public DescriptionTlvBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.- Parameters:
arg
- Tlv from which the builder should be initialized
-
DescriptionTlvBuilder
public DescriptionTlvBuilder(DescriptionTlv base)
Construct a builder initialized with state from specifiedDescriptionTlv
.- Parameters:
base
- DescriptionTlv 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
-
getDescription
public String getDescription()
Return current value associated with the property corresponding toDescriptionTlv.getDescription()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DescriptionTlv>> 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
-
setDescription
public DescriptionTlvBuilder setDescription(String value)
Set the property corresponding toDescriptionTlv.getDescription()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DescriptionTlvBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DescriptionTlv> 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 DescriptionTlvBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DescriptionTlv>> 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
public @NonNull DescriptionTlv build()
A newDescriptionTlv
instance.- Returns:
- A new
DescriptionTlv
instance.
-
-