Class ShardResult1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.get.known.clients._for.all.shards.output.ShardResult1Builder
-
- All Implemented Interfaces:
Builder<ShardResult1>
,CheckedBuilder<ShardResult1,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class ShardResult1Builder extends Object implements Builder<ShardResult1>
Class that buildsShardResult1Builder
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:
ShardResult1Builder createTarget(int fooXyzzy, int barBaz) { return new ShardResult1BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ShardResult1Builder, 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:
ShardResult1Builder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ShardResult1Builder()
ShardResult1Builder(ShardResult1 base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ShardResult1
build()
Map<KnownClientsKey,KnownClients>
getKnownClients()
ShardResult1Builder
setKnownClients(List<KnownClients> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setKnownClients(Map)} instead.ShardResult1Builder
setKnownClients(Map<KnownClientsKey,KnownClients> values)
-
-
-
Constructor Detail
-
ShardResult1Builder
public ShardResult1Builder()
-
ShardResult1Builder
public ShardResult1Builder(ShardResult1 base)
-
-
Method Detail
-
getKnownClients
public Map<KnownClientsKey,KnownClients> getKnownClients()
-
setKnownClients
public ShardResult1Builder setKnownClients(Map<KnownClientsKey,KnownClients> values)
-
setKnownClients
@Deprecated(forRemoval=true) public ShardResult1Builder setKnownClients(List<KnownClients> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setKnownClients(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
-
build
public ShardResult1 build()
- Specified by:
build
in interfaceBuilder<ShardResult1>
- Specified by:
build
in interfaceCheckedBuilder<ShardResult1,IllegalArgumentException>
-
-