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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PrefixSidTlv>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PrefixSidTlv,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PrefixSidTlvBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PrefixSidTlv>
Class that buildsPrefixSidTlvBuilder
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:
PrefixSidTlvBuilder createTarget(int fooXyzzy, int barBaz) { return new PrefixSidTlvBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixSidTlvBuilder, 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 oportunities, 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:
PrefixSidTlvBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixSidTlvBuilder()
PrefixSidTlvBuilder(PrefixSidTlv arg)
PrefixSidTlvBuilder(PrefixSidTlv base)
PrefixSidTlvBuilder(SidLabelIndex arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PrefixSidTlvBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSidTlv>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSidTlv> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
PrefixSidTlv
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Algorithm
getAlgorithm()
Flags
getFlags()
SidLabelIndex
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)
PrefixSidTlvBuilder
setFlags(Flags value)
PrefixSidTlvBuilder
setSidLabelIndex(SidLabelIndex value)
-
-
-
Constructor Detail
-
PrefixSidTlvBuilder
public PrefixSidTlvBuilder()
-
PrefixSidTlvBuilder
public PrefixSidTlvBuilder(PrefixSidTlv arg)
-
PrefixSidTlvBuilder
public PrefixSidTlvBuilder(SidLabelIndex arg)
-
PrefixSidTlvBuilder
public PrefixSidTlvBuilder(PrefixSidTlv base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.PrefixSidTlv
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.SidLabelIndex
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getAlgorithm
public Algorithm getAlgorithm()
-
getFlags
public Flags getFlags()
-
getSidLabelIndex
public SidLabelIndex getSidLabelIndex()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSidTlv>> E$$ augmentation(Class<E$$> augmentationType)
-
setAlgorithm
public PrefixSidTlvBuilder setAlgorithm(Algorithm value)
-
setFlags
public PrefixSidTlvBuilder setFlags(Flags value)
-
setSidLabelIndex
public PrefixSidTlvBuilder setSidLabelIndex(SidLabelIndex value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public PrefixSidTlvBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSidTlv>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSidTlv> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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 PrefixSidTlv build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PrefixSidTlv>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PrefixSidTlv,IllegalArgumentException>
-
-