Class UpgradeConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.upgrade.rev180702.UpgradeConfigBuilder
-
@Generated("mdsal-binding-generator") public class UpgradeConfigBuilder extends Object
Class that buildsUpgradeConfig
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:
UpgradeConfig createUpgradeConfig(int fooXyzzy, int barBaz) { return new UpgradeConfigBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpgradeConfig, 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:
UpgradeConfig
- 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 UpgradeConfigBuilder()
Construct an empty builder.UpgradeConfigBuilder(UpgradeConfig base)
Construct a builder initialized with state from specifiedUpgradeConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpgradeConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UpgradeConfig
build()
A newUpgradeConfig
instance.Boolean
getUpgradeInProgress()
Return current value associated with the property corresponding toUpgradeConfig.getUpgradeInProgress()
.UpgradeConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>> augmentationType)
Remove an augmentation from this builder's product.UpgradeConfigBuilder
setUpgradeInProgress(Boolean value)
Set the property corresponding toUpgradeConfig.getUpgradeInProgress()
to the specified value.
-
-
-
Constructor Detail
-
UpgradeConfigBuilder
public UpgradeConfigBuilder()
Construct an empty builder.
-
UpgradeConfigBuilder
public UpgradeConfigBuilder(UpgradeConfig base)
Construct a builder initialized with state from specifiedUpgradeConfig
.- Parameters:
base
- UpgradeConfig from which the builder should be initialized
-
-
Method Detail
-
getUpgradeInProgress
public Boolean getUpgradeInProgress()
Return current value associated with the property corresponding toUpgradeConfig.getUpgradeInProgress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>> 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
-
setUpgradeInProgress
public UpgradeConfigBuilder setUpgradeInProgress(Boolean value)
Set the property corresponding toUpgradeConfig.getUpgradeInProgress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UpgradeConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig> 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 UpgradeConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>> 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 UpgradeConfig build()
A newUpgradeConfig
instance.- Returns:
- A new
UpgradeConfig
instance.
-
-