Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.node.state
Class SrAlgorithmBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.node.state.SrAlgorithmBuilder
-
@Generated("mdsal-binding-generator") public class SrAlgorithmBuilder extends Object
Class that buildsSrAlgorithm
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:
SrAlgorithm createSrAlgorithm(int fooXyzzy, int barBaz) { return new SrAlgorithmBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SrAlgorithm, 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:
SrAlgorithm
- 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 SrAlgorithmBuilder()
Construct an empty builder.SrAlgorithmBuilder(SrAlgorithm base)
Construct a builder initialized with state from specifiedSrAlgorithm
.SrAlgorithmBuilder(SrAlgorithmsTlv arg)
Construct a new builder initialized from specifiedSrAlgorithmsTlv
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SrAlgorithmBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrAlgorithm> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrAlgorithm>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SrAlgorithm
build()
A newSrAlgorithm
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Set<Algorithm>
getAlgorithms()
Return current value associated with the property corresponding toSrAlgorithmsTlv.getAlgorithms()
.SrAlgorithmBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrAlgorithm>> augmentationType)
Remove an augmentation from this builder's product.SrAlgorithmBuilder
setAlgorithms(Set<Algorithm> values)
Set the property corresponding toSrAlgorithmsTlv.getAlgorithms()
to the specified value.
-
-
-
Constructor Detail
-
SrAlgorithmBuilder
public SrAlgorithmBuilder()
Construct an empty builder.
-
SrAlgorithmBuilder
public SrAlgorithmBuilder(SrAlgorithmsTlv arg)
Construct a new builder initialized from specifiedSrAlgorithmsTlv
.- Parameters:
arg
- SrAlgorithmsTlv from which the builder should be initialized
-
SrAlgorithmBuilder
public SrAlgorithmBuilder(SrAlgorithm base)
Construct a builder initialized with state from specifiedSrAlgorithm
.- Parameters:
base
- SrAlgorithm 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
-
getAlgorithms
public Set<Algorithm> getAlgorithms()
Return current value associated with the property corresponding toSrAlgorithmsTlv.getAlgorithms()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrAlgorithm>> 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
-
setAlgorithms
public SrAlgorithmBuilder setAlgorithms(Set<Algorithm> values)
Set the property corresponding toSrAlgorithmsTlv.getAlgorithms()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SrAlgorithmBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrAlgorithm> 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 SrAlgorithmBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrAlgorithm>> 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 SrAlgorithm build()
A newSrAlgorithm
instance.- Returns:
- A new
SrAlgorithm
instance.
-
-