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