Class AllocationPoolsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnet.attributes.AllocationPoolsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AllocationPools>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AllocationPools,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AllocationPoolsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AllocationPools>
Class that buildsAllocationPoolsBuilder
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:
AllocationPoolsBuilder createTarget(int fooXyzzy, int barBaz) { return new AllocationPoolsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AllocationPoolsBuilder, 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:
AllocationPoolsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AllocationPoolsBuilder()
AllocationPoolsBuilder(AllocationPools base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AllocationPoolsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPools> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPools>>
E$$augmentation(Class<E$$> augmentationType)
AllocationPools
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getEnd()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getStart()
AllocationPoolsKey
key()
AllocationPoolsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPools>> augmentationType)
Remove an augmentation from this builder's product.AllocationPoolsBuilder
setEnd(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
AllocationPoolsBuilder
setStart(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
AllocationPoolsBuilder
withKey(AllocationPoolsKey key)
-
-
-
Constructor Detail
-
AllocationPoolsBuilder
public AllocationPoolsBuilder()
-
AllocationPoolsBuilder
public AllocationPoolsBuilder(AllocationPools base)
-
-
Method Detail
-
key
public AllocationPoolsKey key()
-
getEnd
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getEnd()
-
getStart
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getStart()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPools>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public AllocationPoolsBuilder withKey(AllocationPoolsKey key)
-
setEnd
public AllocationPoolsBuilder setEnd(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setStart
public AllocationPoolsBuilder setStart(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
addAugmentation
public AllocationPoolsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPools> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public AllocationPoolsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPools>> 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 AllocationPools build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AllocationPools>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AllocationPools,IllegalArgumentException>
-
-