Class AllocateIdRangeInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdRangeInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AllocateIdRangeInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AllocateIdRangeInput,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AllocateIdRangeInputBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AllocateIdRangeInput>
Class that buildsAllocateIdRangeInputBuilder
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:
AllocateIdRangeInputBuilder createTarget(int fooXyzzy, int barBaz) { return new AllocateIdRangeInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AllocateIdRangeInputBuilder, 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:
AllocateIdRangeInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AllocateIdRangeInputBuilder()
AllocateIdRangeInputBuilder(AllocateIdRangeInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AllocateIdRangeInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AllocateIdRangeInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocateIdRangeInput>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AllocateIdRangeInput
build()
java.lang.String
getIdKey()
java.lang.String
getPoolName()
org.opendaylight.yangtools.yang.common.Uint32
getSize()
AllocateIdRangeInputBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocateIdRangeInput>> augmentationType)
Remove an augmentation from this builder's product.AllocateIdRangeInputBuilder
setIdKey(java.lang.String value)
AllocateIdRangeInputBuilder
setPoolName(java.lang.String value)
AllocateIdRangeInputBuilder
setSize(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSize(Uint32)
instead.AllocateIdRangeInputBuilder
setSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
AllocateIdRangeInputBuilder
public AllocateIdRangeInputBuilder()
-
AllocateIdRangeInputBuilder
public AllocateIdRangeInputBuilder(AllocateIdRangeInput base)
-
-
Method Detail
-
getIdKey
public java.lang.String getIdKey()
-
getPoolName
public java.lang.String getPoolName()
-
getSize
public org.opendaylight.yangtools.yang.common.Uint32 getSize()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocateIdRangeInput>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIdKey
public AllocateIdRangeInputBuilder setIdKey(java.lang.String value)
-
setPoolName
public AllocateIdRangeInputBuilder setPoolName(java.lang.String value)
-
setSize
public AllocateIdRangeInputBuilder setSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSize
@Deprecated(forRemoval=true) public AllocateIdRangeInputBuilder setSize(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSize(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public AllocateIdRangeInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AllocateIdRangeInput> 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
-
removeAugmentation
public AllocateIdRangeInputBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocateIdRangeInput>> 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 AllocateIdRangeInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AllocateIdRangeInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AllocateIdRangeInput,java.lang.IllegalArgumentException>
-
-