Class PrefixShardsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.prefix.shard.configuration.rev170110.PrefixShardsBuilder
-
- All Implemented Interfaces:
Builder<PrefixShards>
,CheckedBuilder<PrefixShards,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class PrefixShardsBuilder extends Object implements Builder<PrefixShards>
Class that buildsPrefixShardsBuilder
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:
PrefixShardsBuilder createTarget(int fooXyzzy, int barBaz) { return new PrefixShardsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixShardsBuilder, 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:
PrefixShardsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixShardsBuilder()
PrefixShardsBuilder(PrefixShards base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PrefixShardsBuilder
addAugmentation(Class<? extends Augmentation<PrefixShards>> augmentationType, Augmentation<PrefixShards> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.PrefixShardsBuilder
addAugmentation(Augmentation<PrefixShards> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<PrefixShards>>
E$$augmentation(Class<E$$> augmentationType)
PrefixShards
build()
Map<ShardKey,Shard>
getShard()
PrefixShardsBuilder
removeAugmentation(Class<? extends Augmentation<PrefixShards>> augmentationType)
Remove an augmentation from this builder's product.PrefixShardsBuilder
setShard(List<Shard> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setShard(Map)} instead.PrefixShardsBuilder
setShard(Map<ShardKey,Shard> values)
-
-
-
Constructor Detail
-
PrefixShardsBuilder
public PrefixShardsBuilder()
-
PrefixShardsBuilder
public PrefixShardsBuilder(PrefixShards base)
-
-
Method Detail
-
augmentation
public <E$$ extends Augmentation<PrefixShards>> E$$ augmentation(Class<E$$> augmentationType)
-
setShard
public PrefixShardsBuilder setShard(Map<ShardKey,Shard> values)
-
setShard
@Deprecated(forRemoval=true) public PrefixShardsBuilder setShard(List<Shard> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setShard(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 PrefixShardsBuilder addAugmentation(Augmentation<PrefixShards> 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 PrefixShardsBuilder addAugmentation(Class<? extends Augmentation<PrefixShards>> augmentationType, Augmentation<PrefixShards> 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 PrefixShardsBuilder removeAugmentation(Class<? extends Augmentation<PrefixShards>> 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 PrefixShards build()
- Specified by:
build
in interfaceBuilder<PrefixShards>
- Specified by:
build
in interfaceCheckedBuilder<PrefixShards,IllegalArgumentException>
-
-