Class AllocationsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.network.AllocationsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Allocations>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Allocations,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AllocationsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Allocations>
Class that buildsAllocationsBuilder
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:
AllocationsBuilder createTarget(int fooXyzzy, int barBaz) { return new AllocationsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AllocationsBuilder, 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:
AllocationsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AllocationsBuilder()
AllocationsBuilder(Allocations base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AllocationsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Allocations> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Allocations>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Allocations
build()
java.util.Map<AllocationInstanceKey,AllocationInstance>
getAllocationInstance()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getSubnet()
AllocationsKey
key()
AllocationsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Allocations>> augmentationType)
Remove an augmentation from this builder's product.AllocationsBuilder
setAllocationInstance(java.util.List<AllocationInstance> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAllocationInstance(Map)
instead.AllocationsBuilder
setAllocationInstance(java.util.Map<AllocationInstanceKey,AllocationInstance> values)
AllocationsBuilder
setSubnet(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
AllocationsBuilder
withKey(AllocationsKey key)
-
-
-
Constructor Detail
-
AllocationsBuilder
public AllocationsBuilder()
-
AllocationsBuilder
public AllocationsBuilder(Allocations base)
-
-
Method Detail
-
key
public AllocationsKey key()
-
getAllocationInstance
public java.util.Map<AllocationInstanceKey,AllocationInstance> getAllocationInstance()
-
getSubnet
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getSubnet()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Allocations>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public AllocationsBuilder withKey(AllocationsKey key)
-
setAllocationInstance
public AllocationsBuilder setAllocationInstance(java.util.Map<AllocationInstanceKey,AllocationInstance> values)
-
setAllocationInstance
@Deprecated(forRemoval=true) public AllocationsBuilder setAllocationInstance(java.util.List<AllocationInstance> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAllocationInstance(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
setSubnet
public AllocationsBuilder setSubnet(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
addAugmentation
public AllocationsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Allocations> 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 AllocationsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Allocations>> 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 Allocations build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Allocations>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Allocations,java.lang.IllegalArgumentException>
-
-