Class MeterBandDropBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.drop._case.MeterBandDropBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeterBandDrop>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeterBandDrop,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MeterBandDropBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeterBandDrop>
Class that buildsMeterBandDropBuilder
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:
MeterBandDropBuilder createTarget(int fooXyzzy, int barBaz) { return new MeterBandDropBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterBandDropBuilder, 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:
MeterBandDropBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterBandDropBuilder()
MeterBandDropBuilder(MeterBandDrop base)
MeterBandDropBuilder(MeterBandCommons arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MeterBandDropBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDrop> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDrop>>
E$$augmentation(Class<E$$> augmentationType)
MeterBandDrop
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getBurstSize()
org.opendaylight.yangtools.yang.common.Uint32
getRate()
MeterBandType
getType()
MeterBandDropBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDrop>> augmentationType)
Remove an augmentation from this builder's product.MeterBandDropBuilder
setBurstSize(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBurstSize(Uint32)
instead.MeterBandDropBuilder
setBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
MeterBandDropBuilder
setRate(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRate(Uint32)
instead.MeterBandDropBuilder
setRate(org.opendaylight.yangtools.yang.common.Uint32 value)
MeterBandDropBuilder
setType(MeterBandType value)
-
-
-
Constructor Detail
-
MeterBandDropBuilder
public MeterBandDropBuilder()
-
MeterBandDropBuilder
public MeterBandDropBuilder(MeterBandCommons arg)
-
MeterBandDropBuilder
public MeterBandDropBuilder(MeterBandDrop 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.openflow.protocol.rev130731.MeterBandCommons
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBurstSize
public org.opendaylight.yangtools.yang.common.Uint32 getBurstSize()
-
getRate
public org.opendaylight.yangtools.yang.common.Uint32 getRate()
-
getType
public MeterBandType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDrop>> E$$ augmentation(Class<E$$> augmentationType)
-
setBurstSize
public MeterBandDropBuilder setBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBurstSize
@Deprecated(forRemoval=true) public MeterBandDropBuilder setBurstSize(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBurstSize(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setRate
public MeterBandDropBuilder setRate(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setRate
@Deprecated(forRemoval=true) public MeterBandDropBuilder setRate(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRate(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setType
public MeterBandDropBuilder setType(MeterBandType value)
-
addAugmentation
public MeterBandDropBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDrop> 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 MeterBandDropBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDrop>> 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 MeterBandDrop build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeterBandDrop>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeterBandDrop,IllegalArgumentException>
-
-