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
-
@Generated("mdsal-binding-generator") public class MeterStatisticsBuilder extends Object
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
- 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
-
-
Constructor Summary
Constructors Constructor Description MeterStatisticsBuilder()
Construct an empty builder.MeterStatisticsBuilder(MeterStatistics base)
Construct a builder initialized with state from specifiedMeterStatistics
.MeterStatisticsBuilder(MeterStatistics arg)
Construct a new builder initialized from specifiedMeterStatistics
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull MeterStatistics
build()
A newMeterStatistics
instance.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()
Return current value associated with the property corresponding toMeterStatistics.getByteInCount()
.Duration
getDuration()
Return current value associated with the property corresponding toMeterStatistics.getDuration()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
getFlowCount()
Return current value associated with the property corresponding toMeterStatistics.getFlowCount()
.MeterBandStats
getMeterBandStats()
Return current value associated with the property corresponding toMeterStatistics.getMeterBandStats()
.MeterId
getMeterId()
Return current value associated with the property corresponding toMeterStatistics.getMeterId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketInCount()
Return current value associated with the property corresponding toMeterStatistics.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)
Set the property corresponding toMeterStatistics.getByteInCount()
to the specified value.MeterStatisticsBuilder
setDuration(Duration value)
Set the property corresponding toMeterStatistics.getDuration()
to the specified value.MeterStatisticsBuilder
setFlowCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
Set the property corresponding toMeterStatistics.getFlowCount()
to the specified value.MeterStatisticsBuilder
setMeterBandStats(MeterBandStats value)
Set the property corresponding toMeterStatistics.getMeterBandStats()
to the specified value.MeterStatisticsBuilder
setMeterId(MeterId value)
Set the property corresponding toMeterStatistics.getMeterId()
to the specified value.MeterStatisticsBuilder
setPacketInCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toMeterStatistics.getPacketInCount()
to the specified value.
-
-
-
Constructor Detail
-
MeterStatisticsBuilder
public MeterStatisticsBuilder()
Construct an empty builder.
-
MeterStatisticsBuilder
public MeterStatisticsBuilder(MeterStatistics arg)
Construct a new builder initialized from specifiedMeterStatistics
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterStatistics from which the builder should be initialized
-
MeterStatisticsBuilder
public MeterStatisticsBuilder(MeterStatistics base)
Construct a builder initialized with state from specifiedMeterStatistics
.- Parameters:
base
- MeterStatistics from which the builder should be initialized
-
-
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:- 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()
Return current value associated with the property corresponding toMeterStatistics.getByteInCount()
.- Returns:
- current value
-
getDuration
public Duration getDuration()
Return current value associated with the property corresponding toMeterStatistics.getDuration()
.- Returns:
- current value
-
getFlowCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getFlowCount()
Return current value associated with the property corresponding toMeterStatistics.getFlowCount()
.- Returns:
- current value
-
getMeterBandStats
public MeterBandStats getMeterBandStats()
Return current value associated with the property corresponding toMeterStatistics.getMeterBandStats()
.- Returns:
- current value
-
getMeterId
public MeterId getMeterId()
Return current value associated with the property corresponding toMeterStatistics.getMeterId()
.- Returns:
- current value
-
getPacketInCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketInCount()
Return current value associated with the property corresponding toMeterStatistics.getPacketInCount()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStatistics>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setByteInCount
public MeterStatisticsBuilder setByteInCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toMeterStatistics.getByteInCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDuration
public MeterStatisticsBuilder setDuration(Duration value)
Set the property corresponding toMeterStatistics.getDuration()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowCount
public MeterStatisticsBuilder setFlowCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
Set the property corresponding toMeterStatistics.getFlowCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterBandStats
public MeterStatisticsBuilder setMeterBandStats(MeterBandStats value)
Set the property corresponding toMeterStatistics.getMeterBandStats()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterId
public MeterStatisticsBuilder setMeterId(MeterId value)
Set the property corresponding toMeterStatistics.getMeterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketInCount
public MeterStatisticsBuilder setPacketInCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toMeterStatistics.getPacketInCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull MeterStatistics build()
A newMeterStatistics
instance.- Returns:
- A new
MeterStatistics
instance.
-
-