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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AggregateFlowStatistics>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AggregateFlowStatistics,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AggregateFlowStatisticsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AggregateFlowStatistics>
Class that buildsAggregateFlowStatisticsBuilder
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:
AggregateFlowStatisticsBuilder createTarget(int fooXyzzy, int barBaz) { return new AggregateFlowStatisticsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AggregateFlowStatisticsBuilder, 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:
AggregateFlowStatisticsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AggregateFlowStatisticsBuilder()
AggregateFlowStatisticsBuilder(AggregateFlowStatistics base)
AggregateFlowStatisticsBuilder(AggregateFlowStatistics arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AggregateFlowStatisticsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.AggregateFlowStatisticsBuilder
addAugmentation(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)
AggregateFlowStatistics
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
getByteCount()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
getFlowCount()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketCount()
AggregateFlowStatisticsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics>> augmentationType)
Remove an augmentation from this builder's product.AggregateFlowStatisticsBuilder
setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
AggregateFlowStatisticsBuilder
setFlowCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
AggregateFlowStatisticsBuilder
setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
-
-
Constructor Detail
-
AggregateFlowStatisticsBuilder
public AggregateFlowStatisticsBuilder()
-
AggregateFlowStatisticsBuilder
public AggregateFlowStatisticsBuilder(AggregateFlowStatistics arg)
-
AggregateFlowStatisticsBuilder
public AggregateFlowStatisticsBuilder(AggregateFlowStatistics 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.model.statistics.types.rev130925.AggregateFlowStatistics
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getByteCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteCount()
-
getFlowCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getFlowCount()
-
getPacketCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketCount()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics>> E$$ augmentation(Class<E$$> augmentationType)
-
setByteCount
public AggregateFlowStatisticsBuilder setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
setFlowCount
public AggregateFlowStatisticsBuilder setFlowCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
-
setPacketCount
public AggregateFlowStatisticsBuilder setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public AggregateFlowStatisticsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AggregateFlowStatistics> 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 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
public AggregateFlowStatistics build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AggregateFlowStatistics>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AggregateFlowStatistics,IllegalArgumentException>
-
-