Class CreateIdPoolInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<CreateIdPoolInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<CreateIdPoolInput,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class CreateIdPoolInputBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<CreateIdPoolInput>
Class that buildsCreateIdPoolInputBuilder
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:
CreateIdPoolInputBuilder createTarget(int fooXyzzy, int barBaz) { return new CreateIdPoolInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CreateIdPoolInputBuilder, 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:
CreateIdPoolInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description CreateIdPoolInputBuilder()
CreateIdPoolInputBuilder(CreateIdPoolInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CreateIdPoolInputBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.CreateIdPoolInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
CreateIdPoolInput
build()
org.opendaylight.yangtools.yang.common.Uint32
getHigh()
org.opendaylight.yangtools.yang.common.Uint32
getLow()
java.lang.String
getPoolName()
CreateIdPoolInputBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput>> augmentationType)
Remove an augmentation from this builder's product.CreateIdPoolInputBuilder
setHigh(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHigh(Uint32)
instead.CreateIdPoolInputBuilder
setHigh(org.opendaylight.yangtools.yang.common.Uint32 value)
CreateIdPoolInputBuilder
setLow(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLow(Uint32)
instead.CreateIdPoolInputBuilder
setLow(org.opendaylight.yangtools.yang.common.Uint32 value)
CreateIdPoolInputBuilder
setPoolName(java.lang.String value)
-
-
-
Constructor Detail
-
CreateIdPoolInputBuilder
public CreateIdPoolInputBuilder()
-
CreateIdPoolInputBuilder
public CreateIdPoolInputBuilder(CreateIdPoolInput base)
-
-
Method Detail
-
getHigh
public org.opendaylight.yangtools.yang.common.Uint32 getHigh()
-
getLow
public org.opendaylight.yangtools.yang.common.Uint32 getLow()
-
getPoolName
public java.lang.String getPoolName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setHigh
public CreateIdPoolInputBuilder setHigh(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setHigh
@Deprecated(forRemoval=true) public CreateIdPoolInputBuilder setHigh(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHigh(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setLow
public CreateIdPoolInputBuilder setLow(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setLow
@Deprecated(forRemoval=true) public CreateIdPoolInputBuilder setLow(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLow(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPoolName
public CreateIdPoolInputBuilder setPoolName(java.lang.String value)
-
addAugmentation
public CreateIdPoolInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public CreateIdPoolInputBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput> 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 CreateIdPoolInputBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CreateIdPoolInput>> 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 CreateIdPoolInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<CreateIdPoolInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<CreateIdPoolInput,java.lang.IllegalArgumentException>
-
-