Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.node.meter.statistics
Class MeterStatisticsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.node.meter.statistics.MeterStatisticsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeterStatistics>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeterStatistics,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MeterStatisticsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeterStatistics>
Class that buildsMeterStatistics
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:
MeterStatistics createMeterStatistics(int fooXyzzy, int barBaz) { return new MeterStatisticsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterStatistics, 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:
MeterStatistics
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterStatisticsBuilder()
MeterStatisticsBuilder(MeterStatistics base)
MeterStatisticsBuilder(MeterStatistics arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterStatisticsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterStatistics> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStatistics>>
E$$augmentation(Class<E$$> augmentationType)
MeterStatistics
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getByteInCount()
Duration
getDuration()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
getFlowCount()
MeterBandStats
getMeterBandStats()
MeterId
getMeterId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketInCount()
MeterStatisticsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStatistics>> augmentationType)
Remove an augmentation from this builder's product.MeterStatisticsBuilder
setByteInCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
MeterStatisticsBuilder
setDuration(Duration value)
MeterStatisticsBuilder
setFlowCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
MeterStatisticsBuilder
setMeterBandStats(MeterBandStats value)
MeterStatisticsBuilder
setMeterId(MeterId value)
MeterStatisticsBuilder
setPacketInCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
-
-
Constructor Detail
-
MeterStatisticsBuilder
public MeterStatisticsBuilder()
-
MeterStatisticsBuilder
public MeterStatisticsBuilder(MeterStatistics arg)
-
MeterStatisticsBuilder
public MeterStatisticsBuilder(MeterStatistics 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.meter.types.rev130918.MeterStatistics
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getByteInCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteInCount()
-
getDuration
public Duration getDuration()
-
getFlowCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getFlowCount()
-
getMeterBandStats
public MeterBandStats getMeterBandStats()
-
getMeterId
public MeterId getMeterId()
-
getPacketInCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketInCount()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStatistics>> E$$ augmentation(Class<E$$> augmentationType)
-
setByteInCount
public MeterStatisticsBuilder setByteInCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
setDuration
public MeterStatisticsBuilder setDuration(Duration value)
-
setFlowCount
public MeterStatisticsBuilder setFlowCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
-
setMeterBandStats
public MeterStatisticsBuilder setMeterBandStats(MeterBandStats value)
-
setMeterId
public MeterStatisticsBuilder setMeterId(MeterId value)
-
setPacketInCount
public MeterStatisticsBuilder setPacketInCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
addAugmentation
public MeterStatisticsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterStatistics> 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 MeterStatisticsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStatistics>> 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 MeterStatistics build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeterStatistics>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeterStatistics,IllegalArgumentException>
-
-