Class GetShardRoleOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.GetShardRoleOutputBuilder
-
- All Implemented Interfaces:
Builder<GetShardRoleOutput>
,CheckedBuilder<GetShardRoleOutput,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class GetShardRoleOutputBuilder extends Object implements Builder<GetShardRoleOutput>
Class that buildsGetShardRoleOutputBuilder
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:
GetShardRoleOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new GetShardRoleOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GetShardRoleOutputBuilder, 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:
GetShardRoleOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GetShardRoleOutputBuilder()
GetShardRoleOutputBuilder(GetShardRoleOutput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GetShardRoleOutputBuilder
addAugmentation(Class<? extends Augmentation<GetShardRoleOutput>> augmentationType, Augmentation<GetShardRoleOutput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.GetShardRoleOutputBuilder
addAugmentation(Augmentation<GetShardRoleOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<GetShardRoleOutput>>
E$$augmentation(Class<E$$> augmentationType)
GetShardRoleOutput
build()
String
getRole()
GetShardRoleOutputBuilder
removeAugmentation(Class<? extends Augmentation<GetShardRoleOutput>> augmentationType)
Remove an augmentation from this builder's product.GetShardRoleOutputBuilder
setRole(String value)
-
-
-
Constructor Detail
-
GetShardRoleOutputBuilder
public GetShardRoleOutputBuilder()
-
GetShardRoleOutputBuilder
public GetShardRoleOutputBuilder(GetShardRoleOutput base)
-
-
Method Detail
-
getRole
public String getRole()
-
augmentation
public <E$$ extends Augmentation<GetShardRoleOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
setRole
public GetShardRoleOutputBuilder setRole(String value)
-
addAugmentation
public GetShardRoleOutputBuilder addAugmentation(Augmentation<GetShardRoleOutput> 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 GetShardRoleOutputBuilder addAugmentation(Class<? extends Augmentation<GetShardRoleOutput>> augmentationType, Augmentation<GetShardRoleOutput> 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 GetShardRoleOutputBuilder removeAugmentation(Class<? extends Augmentation<GetShardRoleOutput>> 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 GetShardRoleOutput build()
- Specified by:
build
in interfaceBuilder<GetShardRoleOutput>
- Specified by:
build
in interfaceCheckedBuilder<GetShardRoleOutput,IllegalArgumentException>
-
-