Class AvailableIdsHolderBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.id.pool.AvailableIdsHolderBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AvailableIdsHolder>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AvailableIdsHolder,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AvailableIdsHolderBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AvailableIdsHolder>
Class that buildsAvailableIdsHolderBuilder
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:
AvailableIdsHolderBuilder createTarget(int fooXyzzy, int barBaz) { return new AvailableIdsHolderBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AvailableIdsHolderBuilder, 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:
AvailableIdsHolderBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AvailableIdsHolderBuilder()
AvailableIdsHolderBuilder(AvailableIds arg)
AvailableIdsHolderBuilder(AvailableIdsHolder base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AvailableIdsHolderBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.AvailableIdsHolderBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AvailableIdsHolder
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.Long
getCursor()
org.opendaylight.yangtools.yang.common.Uint32
getEnd()
org.opendaylight.yangtools.yang.common.Uint32
getStart()
AvailableIdsHolderBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder>> augmentationType)
Remove an augmentation from this builder's product.AvailableIdsHolderBuilder
setCursor(java.lang.Long value)
AvailableIdsHolderBuilder
setEnd(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEnd(Uint32)
instead.AvailableIdsHolderBuilder
setEnd(org.opendaylight.yangtools.yang.common.Uint32 value)
AvailableIdsHolderBuilder
setStart(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetStart(Uint32)
instead.AvailableIdsHolderBuilder
setStart(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
AvailableIdsHolderBuilder
public AvailableIdsHolderBuilder()
-
AvailableIdsHolderBuilder
public AvailableIdsHolderBuilder(AvailableIds arg)
-
AvailableIdsHolderBuilder
public AvailableIdsHolderBuilder(AvailableIdsHolder base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AvailableIds
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getCursor
public java.lang.Long getCursor()
-
getEnd
public org.opendaylight.yangtools.yang.common.Uint32 getEnd()
-
getStart
public org.opendaylight.yangtools.yang.common.Uint32 getStart()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setCursor
public AvailableIdsHolderBuilder setCursor(java.lang.Long value)
-
setEnd
public AvailableIdsHolderBuilder setEnd(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setEnd
@Deprecated(forRemoval=true) public AvailableIdsHolderBuilder setEnd(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEnd(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setStart
public AvailableIdsHolderBuilder setStart(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setStart
@Deprecated(forRemoval=true) public AvailableIdsHolderBuilder setStart(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetStart(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public AvailableIdsHolderBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder> 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 AvailableIdsHolderBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder> 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 AvailableIdsHolderBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AvailableIdsHolder>> 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 AvailableIdsHolder build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AvailableIdsHolder>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AvailableIdsHolder,java.lang.IllegalArgumentException>
-
-