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