Class UpgradeConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.upgrade.rev180702.UpgradeConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UpgradeConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UpgradeConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class UpgradeConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UpgradeConfig>
Class that buildsUpgradeConfigBuilder
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:
UpgradeConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new UpgradeConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpgradeConfigBuilder, 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:
UpgradeConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description UpgradeConfigBuilder()
UpgradeConfigBuilder(UpgradeConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpgradeConfigBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>>
E$$augmentation(Class<E$$> augmentationType)
UpgradeConfig
build()
Boolean
isUpgradeInProgress()
UpgradeConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>> augmentationType)
UpgradeConfigBuilder
setUpgradeInProgress(Boolean value)
-
-
-
Constructor Detail
-
UpgradeConfigBuilder
public UpgradeConfigBuilder()
-
UpgradeConfigBuilder
public UpgradeConfigBuilder(UpgradeConfig base)
-
-
Method Detail
-
isUpgradeInProgress
public Boolean isUpgradeInProgress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>> E$$ augmentation(Class<E$$> augmentationType)
-
setUpgradeInProgress
public UpgradeConfigBuilder setUpgradeInProgress(Boolean value)
-
addAugmentation
public UpgradeConfigBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig> augmentationValue)
-
removeAugmentation
public UpgradeConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpgradeConfig>> augmentationType)
-
build
public UpgradeConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UpgradeConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UpgradeConfig,IllegalArgumentException>
-
-