Class PeerNodeSidBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute.PeerNodeSidBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PeerNodeSid>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PeerNodeSid,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PeerNodeSidBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PeerNodeSid>
Class that buildsPeerNodeSidBuilder
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:
PeerNodeSidBuilder createTarget(int fooXyzzy, int barBaz) { return new PeerNodeSidBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerNodeSidBuilder, 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:
PeerNodeSidBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PeerNodeSidBuilder()
PeerNodeSidBuilder(PeerNodeSid base)
PeerNodeSidBuilder(EpeAdjSidTlv arg)
PeerNodeSidBuilder(SidLabelIndex arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PeerNodeSidBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerNodeSid> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerNodeSid>>
E$$augmentation(Class<E$$> augmentationType)
PeerNodeSid
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.SidLabelIndex
getSidLabelIndex()
Weight
getWeight()
PeerNodeSidBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerNodeSid>> augmentationType)
Remove an augmentation from this builder's product.PeerNodeSidBuilder
setSidLabelIndex(SidLabelIndex value)
PeerNodeSidBuilder
setWeight(Weight value)
-
-
-
Constructor Detail
-
PeerNodeSidBuilder
public PeerNodeSidBuilder()
-
PeerNodeSidBuilder
public PeerNodeSidBuilder(EpeAdjSidTlv arg)
-
PeerNodeSidBuilder
public PeerNodeSidBuilder(SidLabelIndex arg)
-
PeerNodeSidBuilder
public PeerNodeSidBuilder(PeerNodeSid 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.EpeAdjSidTlv
- 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
-
getSidLabelIndex
public SidLabelIndex getSidLabelIndex()
-
getWeight
public Weight getWeight()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerNodeSid>> E$$ augmentation(Class<E$$> augmentationType)
-
setSidLabelIndex
public PeerNodeSidBuilder setSidLabelIndex(SidLabelIndex value)
-
setWeight
public PeerNodeSidBuilder setWeight(Weight value)
-
addAugmentation
public PeerNodeSidBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerNodeSid> 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 PeerNodeSidBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerNodeSid>> 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 PeerNodeSid build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PeerNodeSid>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PeerNodeSid,IllegalArgumentException>
-
-