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