Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.aggregate.flow.statistics
Class AggregateFlowStatisticsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.aggregate.flow.statistics.AggregateFlowStatisticsBuilder
Class that builds
AggregateFlowStatistics
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:
AggregateFlowStatistics createAggregateFlowStatistics(int fooXyzzy, int barBaz) {
return new AggregateFlowStatisticsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of AggregateFlowStatistics, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedAggregateFlowStatistics
.Construct a new builder initialized from specifiedAggregateFlowStatistics
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull AggregateFlowStatistics
build()
A newAggregateFlowStatistics
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
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
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
Return current value associated with the property corresponding toAggregateFlowStatistics.getPacketCount()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics>> augmentationType) Remove an augmentation from this builder's product.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.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.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 Details
-
AggregateFlowStatisticsBuilder
public AggregateFlowStatisticsBuilder()Construct an empty builder. -
AggregateFlowStatisticsBuilder
Construct a new builder initialized from specifiedAggregateFlowStatistics
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.AggregateFlowStatistics from which the builder should be initialized
-
AggregateFlowStatisticsBuilder
Construct a builder initialized with state from specifiedAggregateFlowStatistics
.- Parameters:
base
- AggregateFlowStatistics from which the builder should be initialized
-
-
Method Details
-
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<AggregateFlowStatistics>> 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 AggregateFlowStatisticsBuilder 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 AggregateFlowStatisticsBuilder 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 AggregateFlowStatisticsBuilder 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 AggregateFlowStatisticsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics> 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 AggregateFlowStatisticsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics>> 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
A newAggregateFlowStatistics
instance.- Returns:
- A new
AggregateFlowStatistics
instance.
-