Class PeerAdjSidBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute.PeerAdjSidBuilder
-
@Generated("mdsal-binding-generator") public class PeerAdjSidBuilder extends Object
Class that buildsPeerAdjSid
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:
PeerAdjSid createPeerAdjSid(int fooXyzzy, int barBaz) { return new PeerAdjSidBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerAdjSid, 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:
PeerAdjSid
- 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 PeerAdjSidBuilder()
Construct an empty builder.PeerAdjSidBuilder(PeerAdjSid base)
Construct a builder initialized with state from specifiedPeerAdjSid
.PeerAdjSidBuilder(EpeAdjSidTlv arg)
Construct a new builder initialized from specifiedEpeAdjSidTlv
.PeerAdjSidBuilder(SidLabelIndex arg)
Construct a new builder initialized from specifiedSidLabelIndex
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PeerAdjSidBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerAdjSid> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerAdjSid>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PeerAdjSid
build()
A newPeerAdjSid
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()
.Weight
getWeight()
Return current value associated with the property corresponding toEpeAdjSidTlv.getWeight()
.PeerAdjSidBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerAdjSid>> augmentationType)
Remove an augmentation from this builder's product.PeerAdjSidBuilder
setSidLabelIndex(SidLabelIndex value)
Set the property corresponding toSidLabelIndex.getSidLabelIndex()
to the specified value.PeerAdjSidBuilder
setWeight(Weight value)
Set the property corresponding toEpeAdjSidTlv.getWeight()
to the specified value.
-
-
-
Constructor Detail
-
PeerAdjSidBuilder
public PeerAdjSidBuilder()
Construct an empty builder.
-
PeerAdjSidBuilder
public PeerAdjSidBuilder(EpeAdjSidTlv arg)
Construct a new builder initialized from specifiedEpeAdjSidTlv
.- Parameters:
arg
- EpeAdjSidTlv from which the builder should be initialized
-
PeerAdjSidBuilder
public PeerAdjSidBuilder(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
-
PeerAdjSidBuilder
public PeerAdjSidBuilder(PeerAdjSid base)
Construct a builder initialized with state from specifiedPeerAdjSid
.- Parameters:
base
- PeerAdjSid 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
-
getWeight
public Weight getWeight()
Return current value associated with the property corresponding toEpeAdjSidTlv.getWeight()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerAdjSid>> 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 PeerAdjSidBuilder setSidLabelIndex(SidLabelIndex value)
Set the property corresponding toSidLabelIndex.getSidLabelIndex()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWeight
public PeerAdjSidBuilder setWeight(Weight value)
Set the property corresponding toEpeAdjSidTlv.getWeight()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PeerAdjSidBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerAdjSid> 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 PeerAdjSidBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerAdjSid>> 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 PeerAdjSid build()
A newPeerAdjSid
instance.- Returns:
- A new
PeerAdjSid
instance.
-
-