Class MeterBandDscpRemarkBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.dscp.remark._case.MeterBandDscpRemarkBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeterBandDscpRemark>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeterBandDscpRemark,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MeterBandDscpRemarkBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeterBandDscpRemark>
Class that buildsMeterBandDscpRemarkBuilder
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:
MeterBandDscpRemarkBuilder createTarget(int fooXyzzy, int barBaz) { return new MeterBandDscpRemarkBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterBandDscpRemarkBuilder, 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:
MeterBandDscpRemarkBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterBandDscpRemarkBuilder()
MeterBandDscpRemarkBuilder(MeterBandDscpRemark base)
MeterBandDscpRemarkBuilder(MeterBandCommons arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MeterBandDscpRemarkBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDscpRemark>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDscpRemark> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDscpRemark>>
E$$augmentation(Class<E$$> augmentationType)
MeterBandDscpRemark
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.Uint8
getPrecLevel()
org.opendaylight.yangtools.yang.common.Uint32
getRate()
MeterBandType
getType()
MeterBandDscpRemarkBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDscpRemark>> augmentationType)
MeterBandDscpRemarkBuilder
setBurstSize(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBurstSize(Uint32)} instead.MeterBandDscpRemarkBuilder
setBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
MeterBandDscpRemarkBuilder
setPrecLevel(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPrecLevel(Uint8)} instead.MeterBandDscpRemarkBuilder
setPrecLevel(org.opendaylight.yangtools.yang.common.Uint8 value)
MeterBandDscpRemarkBuilder
setRate(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setRate(Uint32)} instead.MeterBandDscpRemarkBuilder
setRate(org.opendaylight.yangtools.yang.common.Uint32 value)
MeterBandDscpRemarkBuilder
setType(MeterBandType value)
-
-
-
Constructor Detail
-
MeterBandDscpRemarkBuilder
public MeterBandDscpRemarkBuilder()
-
MeterBandDscpRemarkBuilder
public MeterBandDscpRemarkBuilder(MeterBandCommons arg)
-
MeterBandDscpRemarkBuilder
public MeterBandDscpRemarkBuilder(MeterBandDscpRemark 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
-
getBurstSize
public org.opendaylight.yangtools.yang.common.Uint32 getBurstSize()
-
getPrecLevel
public org.opendaylight.yangtools.yang.common.Uint8 getPrecLevel()
-
getRate
public org.opendaylight.yangtools.yang.common.Uint32 getRate()
-
getType
public MeterBandType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDscpRemark>> E$$ augmentation(Class<E$$> augmentationType)
-
setBurstSize
public MeterBandDscpRemarkBuilder setBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBurstSize
@Deprecated(forRemoval=true) public MeterBandDscpRemarkBuilder setBurstSize(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBurstSize(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPrecLevel
public MeterBandDscpRemarkBuilder setPrecLevel(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setPrecLevel
@Deprecated(forRemoval=true) public MeterBandDscpRemarkBuilder setPrecLevel(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPrecLevel(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setRate
public MeterBandDscpRemarkBuilder setRate(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setRate
@Deprecated(forRemoval=true) public MeterBandDscpRemarkBuilder setRate(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setRate(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setType
public MeterBandDscpRemarkBuilder setType(MeterBandType value)
-
addAugmentation
public MeterBandDscpRemarkBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDscpRemark>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDscpRemark> augmentationValue)
-
removeAugmentation
public MeterBandDscpRemarkBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandDscpRemark>> augmentationType)
-
build
public MeterBandDscpRemark build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeterBandDscpRemark>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeterBandDscpRemark,IllegalArgumentException>
-
-