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