Class AddReplicasForAllShardsOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.AddReplicasForAllShardsOutputBuilder
-
- All Implemented Interfaces:
Builder<AddReplicasForAllShardsOutput>
,CheckedBuilder<AddReplicasForAllShardsOutput,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class AddReplicasForAllShardsOutputBuilder extends Object implements Builder<AddReplicasForAllShardsOutput>
Class that buildsAddReplicasForAllShardsOutputBuilder
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:
AddReplicasForAllShardsOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new AddReplicasForAllShardsOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddReplicasForAllShardsOutputBuilder, 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:
AddReplicasForAllShardsOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AddReplicasForAllShardsOutputBuilder()
AddReplicasForAllShardsOutputBuilder(AddReplicasForAllShardsOutput base)
AddReplicasForAllShardsOutputBuilder(ShardResultOutput arg)
-
Method Summary
-
-
-
Constructor Detail
-
AddReplicasForAllShardsOutputBuilder
public AddReplicasForAllShardsOutputBuilder()
-
AddReplicasForAllShardsOutputBuilder
public AddReplicasForAllShardsOutputBuilder(ShardResultOutput arg)
-
AddReplicasForAllShardsOutputBuilder
public AddReplicasForAllShardsOutputBuilder(AddReplicasForAllShardsOutput base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(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.controller.md.sal.cluster.admin.rev151013.ShardResultOutput
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getShardResult
public Map<ShardResultKey,ShardResult> getShardResult()
-
augmentation
public <E$$ extends Augmentation<AddReplicasForAllShardsOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
setShardResult
public AddReplicasForAllShardsOutputBuilder setShardResult(Map<ShardResultKey,ShardResult> values)
-
setShardResult
@Deprecated(forRemoval=true) public AddReplicasForAllShardsOutputBuilder setShardResult(List<ShardResult> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setShardResult(Map)} instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public AddReplicasForAllShardsOutputBuilder addAugmentation(Augmentation<AddReplicasForAllShardsOutput> 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 AddReplicasForAllShardsOutputBuilder removeAugmentation(Class<? extends Augmentation<AddReplicasForAllShardsOutput>> 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 AddReplicasForAllShardsOutput build()
- Specified by:
build
in interfaceBuilder<AddReplicasForAllShardsOutput>
- Specified by:
build
in interfaceCheckedBuilder<AddReplicasForAllShardsOutput,IllegalArgumentException>
-
-