Class LuLabelIndexTlvBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.labeled.unicast.routes.list.labeled.unicast.route.attributes.bgp.prefix.sid.bgp.prefix.sid.tlvs.bgp.prefix.sid.tlv.LuLabelIndexTlvBuilder
-
@Generated("mdsal-binding-generator") public class LuLabelIndexTlvBuilder extends Object
Class that buildsLuLabelIndexTlv
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:
LuLabelIndexTlv createLuLabelIndexTlv(int fooXyzzy, int barBaz) { return new LuLabelIndexTlvBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LuLabelIndexTlv, 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:
LuLabelIndexTlv
- 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 LuLabelIndexTlvBuilder()
Construct an empty builder.LuLabelIndexTlvBuilder(LuLabelIndexTlv base)
Construct a builder initialized with state from specifiedLuLabelIndexTlv
.LuLabelIndexTlvBuilder(LabelIndexTlv arg)
Construct a new builder initialized from specifiedLabelIndexTlv
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LuLabelIndexTlvBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LuLabelIndexTlv> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LuLabelIndexTlv>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LuLabelIndexTlv
build()
A newLuLabelIndexTlv
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getLabelIndexTlv()
Return current value associated with the property corresponding toLabelIndexTlv.getLabelIndexTlv()
.LuLabelIndexTlvBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LuLabelIndexTlv>> augmentationType)
Remove an augmentation from this builder's product.LuLabelIndexTlvBuilder
setLabelIndexTlv(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toLabelIndexTlv.getLabelIndexTlv()
to the specified value.
-
-
-
Constructor Detail
-
LuLabelIndexTlvBuilder
public LuLabelIndexTlvBuilder()
Construct an empty builder.
-
LuLabelIndexTlvBuilder
public LuLabelIndexTlvBuilder(LabelIndexTlv arg)
Construct a new builder initialized from specifiedLabelIndexTlv
.- Parameters:
arg
- LabelIndexTlv from which the builder should be initialized
-
LuLabelIndexTlvBuilder
public LuLabelIndexTlvBuilder(LuLabelIndexTlv base)
Construct a builder initialized with state from specifiedLuLabelIndexTlv
.- Parameters:
base
- LuLabelIndexTlv 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
-
getLabelIndexTlv
public org.opendaylight.yangtools.yang.common.Uint32 getLabelIndexTlv()
Return current value associated with the property corresponding toLabelIndexTlv.getLabelIndexTlv()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LuLabelIndexTlv>> 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
-
setLabelIndexTlv
public LuLabelIndexTlvBuilder setLabelIndexTlv(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toLabelIndexTlv.getLabelIndexTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LuLabelIndexTlvBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LuLabelIndexTlv> 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 LuLabelIndexTlvBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LuLabelIndexTlv>> 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 LuLabelIndexTlv build()
A newLuLabelIndexTlv
instance.- Returns:
- A new
LuLabelIndexTlv
instance.
-
-