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