Class LocateShardOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.LocateShardOutputBuilder
-
- All Implemented Interfaces:
Builder<LocateShardOutput>
,CheckedBuilder<LocateShardOutput,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
@Generated("mdsal-binding-generator") public class LocateShardOutputBuilder extends Object implements Builder<LocateShardOutput>
Class that buildsLocateShardOutputBuilder
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:
LocateShardOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new LocateShardOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LocateShardOutputBuilder, 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:
LocateShardOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LocateShardOutputBuilder()
LocateShardOutputBuilder(LocateShardOutput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LocateShardOutputBuilder
addAugmentation(Augmentation<LocateShardOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<LocateShardOutput>>
E$$augmentation(Class<E$$> augmentationType)
LocateShardOutput
build()
MemberNode
getMemberNode()
LocateShardOutputBuilder
removeAugmentation(Class<? extends Augmentation<LocateShardOutput>> augmentationType)
Remove an augmentation from this builder's product.LocateShardOutputBuilder
setMemberNode(MemberNode value)
-
-
-
Constructor Detail
-
LocateShardOutputBuilder
public LocateShardOutputBuilder()
-
LocateShardOutputBuilder
public LocateShardOutputBuilder(LocateShardOutput base)
-
-
Method Detail
-
getMemberNode
public MemberNode getMemberNode()
-
augmentation
public <E$$ extends Augmentation<LocateShardOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
setMemberNode
public LocateShardOutputBuilder setMemberNode(MemberNode value)
-
addAugmentation
public LocateShardOutputBuilder addAugmentation(Augmentation<LocateShardOutput> 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 LocateShardOutputBuilder removeAugmentation(Class<? extends Augmentation<LocateShardOutput>> 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 LocateShardOutput build()
- Specified by:
build
in interfaceBuilder<LocateShardOutput>
- Specified by:
build
in interfaceCheckedBuilder<LocateShardOutput,IllegalArgumentException>
-
-