Class RecoverInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.srm.rpc.rev180626.RecoverInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RecoverInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RecoverInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RecoverInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<RecoverInput>
Class that buildsRecoverInputBuilder
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:
RecoverInputBuilder createTarget(int fooXyzzy, int barBaz) { return new RecoverInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RecoverInputBuilder, 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:
RecoverInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RecoverInputBuilder()
RecoverInputBuilder(RecoverInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RecoverInputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.RecoverInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput>>
E$$augmentation(Class<E$$> augmentationType)
RecoverInput
build()
String
getEntityId()
Class<? extends EntityNameBase>
getEntityName()
Class<? extends EntityTypeBase>
getEntityType()
RecoverInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput>> augmentationType)
Remove an augmentation from this builder's product.RecoverInputBuilder
setEntityId(String value)
RecoverInputBuilder
setEntityName(Class<? extends EntityNameBase> value)
RecoverInputBuilder
setEntityType(Class<? extends EntityTypeBase> value)
-
-
-
Constructor Detail
-
RecoverInputBuilder
public RecoverInputBuilder()
-
RecoverInputBuilder
public RecoverInputBuilder(RecoverInput base)
-
-
Method Detail
-
getEntityId
public String getEntityId()
-
getEntityName
public Class<? extends EntityNameBase> getEntityName()
-
getEntityType
public Class<? extends EntityTypeBase> getEntityType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setEntityId
public RecoverInputBuilder setEntityId(String value)
-
setEntityName
public RecoverInputBuilder setEntityName(Class<? extends EntityNameBase> value)
-
setEntityType
public RecoverInputBuilder setEntityType(Class<? extends EntityTypeBase> value)
-
addAugmentation
public RecoverInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public RecoverInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public RecoverInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RecoverInput>> 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 RecoverInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RecoverInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RecoverInput,IllegalArgumentException>
-
-