Class KnownClientsBuilder
- 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.shard.result.KnownClientsBuilder
-
- All Implemented Interfaces:
Builder<KnownClients>
,CheckedBuilder<KnownClients,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class KnownClientsBuilder extends Object implements Builder<KnownClients>
Class that buildsKnownClientsBuilder
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:
KnownClientsBuilder createTarget(int fooXyzzy, int barBaz) { return new KnownClientsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of KnownClientsBuilder, 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:
KnownClientsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description KnownClientsBuilder()
KnownClientsBuilder(ClientIdentifier arg)
KnownClientsBuilder(FrontendIdentifier arg)
KnownClientsBuilder(KnownClients base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description KnownClientsBuilder
addAugmentation(Augmentation<KnownClients> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<KnownClients>>
E$$augmentation(Class<E$$> augmentationType)
KnownClients
build()
void
fieldsFrom(DataObject arg)
Set fields from given grouping argument.ClientGeneration
getGeneration()
MemberName
getMember()
FrontendType
getType()
KnownClientsKey
key()
KnownClientsBuilder
removeAugmentation(Class<? extends Augmentation<KnownClients>> augmentationType)
Remove an augmentation from this builder's product.KnownClientsBuilder
setGeneration(ClientGeneration value)
KnownClientsBuilder
setMember(MemberName value)
KnownClientsBuilder
setType(FrontendType value)
KnownClientsBuilder
withKey(KnownClientsKey key)
-
-
-
Constructor Detail
-
KnownClientsBuilder
public KnownClientsBuilder()
-
KnownClientsBuilder
public KnownClientsBuilder(ClientIdentifier arg)
-
KnownClientsBuilder
public KnownClientsBuilder(FrontendIdentifier arg)
-
KnownClientsBuilder
public KnownClientsBuilder(KnownClients base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.FrontendIdentifier
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.ClientIdentifier
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public KnownClientsKey key()
-
getGeneration
public ClientGeneration getGeneration()
-
getMember
public MemberName getMember()
-
getType
public FrontendType getType()
-
augmentation
public <E$$ extends Augmentation<KnownClients>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public KnownClientsBuilder withKey(KnownClientsKey key)
-
setGeneration
public KnownClientsBuilder setGeneration(ClientGeneration value)
-
setMember
public KnownClientsBuilder setMember(MemberName value)
-
setType
public KnownClientsBuilder setType(FrontendType value)
-
addAugmentation
public KnownClientsBuilder addAugmentation(Augmentation<KnownClients> 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 KnownClientsBuilder removeAugmentation(Class<? extends Augmentation<KnownClients>> 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 KnownClients build()
- Specified by:
build
in interfaceBuilder<KnownClients>
- Specified by:
build
in interfaceCheckedBuilder<KnownClients,IllegalArgumentException>
-
-