Class PrefixSidBuilder
- 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.prefix.sid._case.PrefixSidBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PrefixSid>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PrefixSid,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PrefixSidBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PrefixSid>
Class that buildsPrefixSidBuilder
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:
PrefixSidBuilder createTarget(int fooXyzzy, int barBaz) { return new PrefixSidBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixSidBuilder, 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:
PrefixSidBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixSidBuilder()
PrefixSidBuilder(PrefixSid base)
PrefixSidBuilder(PrefixSidTlv arg)
PrefixSidBuilder(SidLabelIndex arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixSidBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSid> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSid>>
E$$augmentation(Class<E$$> augmentationType)
PrefixSid
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Algorithm
getAlgorithm()
Flags
getFlags()
SidLabelIndex
getSidLabelIndex()
PrefixSidBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSid>> augmentationType)
Remove an augmentation from this builder's product.PrefixSidBuilder
setAlgorithm(Algorithm value)
PrefixSidBuilder
setFlags(Flags value)
PrefixSidBuilder
setSidLabelIndex(SidLabelIndex value)
-
-
-
Constructor Detail
-
PrefixSidBuilder
public PrefixSidBuilder()
-
PrefixSidBuilder
public PrefixSidBuilder(PrefixSidTlv arg)
-
PrefixSidBuilder
public PrefixSidBuilder(SidLabelIndex arg)
-
PrefixSidBuilder
public PrefixSidBuilder(PrefixSid 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 or has property with incompatible value
-
getAlgorithm
public Algorithm getAlgorithm()
-
getFlags
public Flags getFlags()
-
getSidLabelIndex
public SidLabelIndex getSidLabelIndex()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSid>> E$$ augmentation(Class<E$$> augmentationType)
-
setAlgorithm
public PrefixSidBuilder setAlgorithm(Algorithm value)
-
setFlags
public PrefixSidBuilder setFlags(Flags value)
-
setSidLabelIndex
public PrefixSidBuilder setSidLabelIndex(SidLabelIndex value)
-
addAugmentation
public PrefixSidBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSid> 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 PrefixSidBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSid>> 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 PrefixSid build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PrefixSid>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PrefixSid,IllegalArgumentException>
-
-