Class AggregatedFlowStatisticsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.get.aggregate.flow.statistics.from.flow.table._for.given.match.output.AggregatedFlowStatisticsBuilder
-
@Generated("mdsal-binding-generator") public class AggregatedFlowStatisticsBuilder extends Object
Class that buildsAggregatedFlowStatistics
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:
AggregatedFlowStatistics createAggregatedFlowStatistics(int fooXyzzy, int barBaz) { return new AggregatedFlowStatisticsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AggregatedFlowStatistics, 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:
AggregatedFlowStatistics
- 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 AggregatedFlowStatisticsBuilder()
Construct an empty builder.AggregatedFlowStatisticsBuilder(AggregatedFlowStatistics base)
Construct a builder initialized with state from specifiedAggregatedFlowStatistics
.AggregatedFlowStatisticsBuilder(AggregateFlowStatistics arg)
Construct a new builder initialized from specifiedAggregateFlowStatistics
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AggregatedFlowStatisticsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AggregatedFlowStatistics> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregatedFlowStatistics>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull AggregatedFlowStatistics
build()
A newAggregatedFlowStatistics
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
getByteCount()
Return current value associated with the property corresponding toAggregateFlowStatistics.getByteCount()
.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 toAggregateFlowStatistics.getFlowCount()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketCount()
Return current value associated with the property corresponding toAggregateFlowStatistics.getPacketCount()
.AggregatedFlowStatisticsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregatedFlowStatistics>> augmentationType)
Remove an augmentation from this builder's product.AggregatedFlowStatisticsBuilder
setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toAggregateFlowStatistics.getByteCount()
to the specified value.AggregatedFlowStatisticsBuilder
setFlowCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
Set the property corresponding toAggregateFlowStatistics.getFlowCount()
to the specified value.AggregatedFlowStatisticsBuilder
setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toAggregateFlowStatistics.getPacketCount()
to the specified value.
-
-
-
Constructor Detail
-
AggregatedFlowStatisticsBuilder
public AggregatedFlowStatisticsBuilder()
Construct an empty builder.
-
AggregatedFlowStatisticsBuilder
public AggregatedFlowStatisticsBuilder(AggregateFlowStatistics arg)
Construct a new builder initialized from specifiedAggregateFlowStatistics
.- Parameters:
arg
- AggregateFlowStatistics from which the builder should be initialized
-
AggregatedFlowStatisticsBuilder
public AggregatedFlowStatisticsBuilder(AggregatedFlowStatistics base)
Construct a builder initialized with state from specifiedAggregatedFlowStatistics
.- Parameters:
base
- AggregatedFlowStatistics 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
-
getByteCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteCount()
Return current value associated with the property corresponding toAggregateFlowStatistics.getByteCount()
.- 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 toAggregateFlowStatistics.getFlowCount()
.- Returns:
- current value
-
getPacketCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketCount()
Return current value associated with the property corresponding toAggregateFlowStatistics.getPacketCount()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregatedFlowStatistics>> 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
-
setByteCount
public AggregatedFlowStatisticsBuilder setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toAggregateFlowStatistics.getByteCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowCount
public AggregatedFlowStatisticsBuilder setFlowCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
Set the property corresponding toAggregateFlowStatistics.getFlowCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketCount
public AggregatedFlowStatisticsBuilder setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toAggregateFlowStatistics.getPacketCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AggregatedFlowStatisticsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AggregatedFlowStatistics> 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 AggregatedFlowStatisticsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregatedFlowStatistics>> 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 AggregatedFlowStatistics build()
A newAggregatedFlowStatistics
instance.- Returns:
- A new
AggregatedFlowStatistics
instance.
-
-