Class GetKnownClientsForAllShardsOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.GetKnownClientsForAllShardsOutputBuilder
-
- All Implemented Interfaces:
Builder<GetKnownClientsForAllShardsOutput>
,CheckedBuilder<GetKnownClientsForAllShardsOutput,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
@Generated("mdsal-binding-generator") public class GetKnownClientsForAllShardsOutputBuilder extends Object implements Builder<GetKnownClientsForAllShardsOutput>
Class that buildsGetKnownClientsForAllShardsOutputBuilder
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:
GetKnownClientsForAllShardsOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new GetKnownClientsForAllShardsOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GetKnownClientsForAllShardsOutputBuilder, 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:
GetKnownClientsForAllShardsOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GetKnownClientsForAllShardsOutputBuilder()
GetKnownClientsForAllShardsOutputBuilder(GetKnownClientsForAllShardsOutput base)
GetKnownClientsForAllShardsOutputBuilder(ShardResultOutput arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetKnownClientsForAllShardsOutputBuilder
addAugmentation(Augmentation<GetKnownClientsForAllShardsOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<GetKnownClientsForAllShardsOutput>>
E$$augmentation(Class<E$$> augmentationType)
GetKnownClientsForAllShardsOutput
build()
void
fieldsFrom(DataObject arg)
Set fields from given grouping argument.Map<ShardResultKey,ShardResult>
getShardResult()
GetKnownClientsForAllShardsOutputBuilder
removeAugmentation(Class<? extends Augmentation<GetKnownClientsForAllShardsOutput>> augmentationType)
Remove an augmentation from this builder's product.GetKnownClientsForAllShardsOutputBuilder
setShardResult(Map<ShardResultKey,ShardResult> values)
-
-
-
Constructor Detail
-
GetKnownClientsForAllShardsOutputBuilder
public GetKnownClientsForAllShardsOutputBuilder()
-
GetKnownClientsForAllShardsOutputBuilder
public GetKnownClientsForAllShardsOutputBuilder(ShardResultOutput arg)
-
GetKnownClientsForAllShardsOutputBuilder
public GetKnownClientsForAllShardsOutputBuilder(GetKnownClientsForAllShardsOutput base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- ShardResultOutput
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getShardResult
public Map<ShardResultKey,ShardResult> getShardResult()
-
augmentation
public <E$$ extends Augmentation<GetKnownClientsForAllShardsOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
setShardResult
public GetKnownClientsForAllShardsOutputBuilder setShardResult(Map<ShardResultKey,ShardResult> values)
-
addAugmentation
public GetKnownClientsForAllShardsOutputBuilder addAugmentation(Augmentation<GetKnownClientsForAllShardsOutput> 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 GetKnownClientsForAllShardsOutputBuilder removeAugmentation(Class<? extends Augmentation<GetKnownClientsForAllShardsOutput>> 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 GetKnownClientsForAllShardsOutput build()
- Specified by:
build
in interfaceBuilder<GetKnownClientsForAllShardsOutput>
- Specified by:
build
in interfaceCheckedBuilder<GetKnownClientsForAllShardsOutput,IllegalArgumentException>
-
-