Class AddShardReplicaInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.AddShardReplicaInputBuilder
-
- All Implemented Interfaces:
Builder<AddShardReplicaInput>
,CheckedBuilder<AddShardReplicaInput,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class AddShardReplicaInputBuilder extends Object implements Builder<AddShardReplicaInput>
Class that buildsAddShardReplicaInputBuilder
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:
AddShardReplicaInputBuilder createTarget(int fooXyzzy, int barBaz) { return new AddShardReplicaInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddShardReplicaInputBuilder, 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:
AddShardReplicaInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AddShardReplicaInputBuilder()
AddShardReplicaInputBuilder(AddShardReplicaInput base)
AddShardReplicaInputBuilder(DatastoreShardId arg)
-
Method Summary
-
-
-
Constructor Detail
-
AddShardReplicaInputBuilder
public AddShardReplicaInputBuilder()
-
AddShardReplicaInputBuilder
public AddShardReplicaInputBuilder(DatastoreShardId arg)
-
AddShardReplicaInputBuilder
public AddShardReplicaInputBuilder(AddShardReplicaInput 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.DatastoreShardId
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getDataStoreType
public DataStoreType getDataStoreType()
-
getShardName
public String getShardName()
-
augmentation
public <E$$ extends Augmentation<AddShardReplicaInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setDataStoreType
public AddShardReplicaInputBuilder setDataStoreType(DataStoreType value)
-
setShardName
public AddShardReplicaInputBuilder setShardName(String value)
-
addAugmentation
public AddShardReplicaInputBuilder addAugmentation(Augmentation<AddShardReplicaInput> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public AddShardReplicaInputBuilder addAugmentation(Class<? extends Augmentation<AddShardReplicaInput>> augmentationType, Augmentation<AddShardReplicaInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public AddShardReplicaInputBuilder removeAugmentation(Class<? extends Augmentation<AddShardReplicaInput>> 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 AddShardReplicaInput build()
- Specified by:
build
in interfaceBuilder<AddShardReplicaInput>
- Specified by:
build
in interfaceCheckedBuilder<AddShardReplicaInput,IllegalArgumentException>
-
-