Class MeterBandStatsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.MeterBandStatsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeterBandStats>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeterBandStats,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MeterBandStatsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeterBandStats>
Class that buildsMeterBandStatsBuilder
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:
MeterBandStatsBuilder createTarget(int fooXyzzy, int barBaz) { return new MeterBandStatsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterBandStatsBuilder, 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:
MeterBandStatsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterBandStatsBuilder()
MeterBandStatsBuilder(MeterBandStats base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MeterBandStatsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.MeterBandStatsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats>>
E$$augmentation(Class<E$$> augmentationType)
MeterBandStats
build()
Map<BandStatKey,BandStat>
getBandStat()
MeterBandStatsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats>> augmentationType)
Remove an augmentation from this builder's product.MeterBandStatsBuilder
setBandStat(List<BandStat> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBandStat(Map)
instead.MeterBandStatsBuilder
setBandStat(Map<BandStatKey,BandStat> values)
-
-
-
Constructor Detail
-
MeterBandStatsBuilder
public MeterBandStatsBuilder()
-
MeterBandStatsBuilder
public MeterBandStatsBuilder(MeterBandStats base)
-
-
Method Detail
-
getBandStat
public Map<BandStatKey,BandStat> getBandStat()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats>> E$$ augmentation(Class<E$$> augmentationType)
-
setBandStat
public MeterBandStatsBuilder setBandStat(Map<BandStatKey,BandStat> values)
-
setBandStat
@Deprecated(forRemoval=true) public MeterBandStatsBuilder setBandStat(List<BandStat> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBandStat(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:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public MeterBandStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public MeterBandStatsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public MeterBandStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandStats>> 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 MeterBandStats build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeterBandStats>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeterBandStats,IllegalArgumentException>
-
-