Class DropBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.DropBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Drop>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Drop,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class DropBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Drop>
Class that buildsDrop
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:
Drop createDrop(int fooXyzzy, int barBaz) { return new DropBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Drop, 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 opportunities, 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:
Drop
,Builder
-
-
Constructor Summary
Constructors Constructor Description DropBuilder()
DropBuilder(Drop base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DropBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Drop> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Drop>>
E$$augmentation(Class<E$$> augmentationType)
Drop
build()
org.opendaylight.yangtools.yang.common.Uint32
getDropBurstSize()
org.opendaylight.yangtools.yang.common.Uint32
getDropRate()
DropBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Drop>> augmentationType)
Remove an augmentation from this builder's product.DropBuilder
setDropBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
DropBuilder
setDropRate(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
DropBuilder
public DropBuilder()
-
DropBuilder
public DropBuilder(Drop base)
-
-
Method Detail
-
getDropBurstSize
public org.opendaylight.yangtools.yang.common.Uint32 getDropBurstSize()
-
getDropRate
public org.opendaylight.yangtools.yang.common.Uint32 getDropRate()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Drop>> E$$ augmentation(Class<E$$> augmentationType)
-
setDropBurstSize
public DropBuilder setDropBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDropRate
public DropBuilder setDropRate(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public DropBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Drop> 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 DropBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Drop>> 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 Drop build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Drop>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Drop,IllegalArgumentException>
-
-