Class FlowTableAndStatisticsMapBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.flow.table.and.statistics.map.FlowTableAndStatisticsMapBuilder
Class that builds
FlowTableAndStatisticsMap
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:
FlowTableAndStatisticsMap createFlowTableAndStatisticsMap(int fooXyzzy, int barBaz) {
return new FlowTableAndStatisticsMapBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of FlowTableAndStatisticsMap, 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
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedFlowTableAndStatisticsMap
.Construct a new builder initialized from specifiedGenericTableStatistics
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableAndStatisticsMap> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableAndStatisticsMap>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull FlowTableAndStatisticsMap
build()
A newFlowTableAndStatisticsMap
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.Counter32
Return current value associated with the property corresponding toGenericTableStatistics.getActiveFlows()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
Return current value associated with the property corresponding toGenericTableStatistics.getPacketsLookedUp()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
Return current value associated with the property corresponding toGenericTableStatistics.getPacketsMatched()
.Return current value associated with the property corresponding toFlowTableAndStatisticsMap.getTableId()
.key()
Return current value associated with the property corresponding toFlowTableAndStatisticsMap.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableAndStatisticsMap>> augmentationType) Remove an augmentation from this builder's product.setActiveFlows
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value) Set the property corresponding toGenericTableStatistics.getActiveFlows()
to the specified value.setPacketsLookedUp
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value) Set the property corresponding toGenericTableStatistics.getPacketsLookedUp()
to the specified value.setPacketsMatched
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value) Set the property corresponding toGenericTableStatistics.getPacketsMatched()
to the specified value.setTableId
(TableId value) Set the property corresponding toFlowTableAndStatisticsMap.getTableId()
to the specified value.Set the key value corresponding toFlowTableAndStatisticsMap.key()
to the specified value.
-
Constructor Details
-
FlowTableAndStatisticsMapBuilder
public FlowTableAndStatisticsMapBuilder()Construct an empty builder. -
FlowTableAndStatisticsMapBuilder
Construct a new builder initialized from specifiedGenericTableStatistics
.- Parameters:
arg
- GenericTableStatistics from which the builder should be initialized
-
FlowTableAndStatisticsMapBuilder
Construct a builder initialized with state from specifiedFlowTableAndStatisticsMap
.- Parameters:
base
- FlowTableAndStatisticsMap 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
-
key
Return current value associated with the property corresponding toFlowTableAndStatisticsMap.key()
.- Returns:
- current value
-
getActiveFlows
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getActiveFlows()Return current value associated with the property corresponding toGenericTableStatistics.getActiveFlows()
.- Returns:
- current value
-
getPacketsLookedUp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketsLookedUp()Return current value associated with the property corresponding toGenericTableStatistics.getPacketsLookedUp()
.- Returns:
- current value
-
getPacketsMatched
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketsMatched()Return current value associated with the property corresponding toGenericTableStatistics.getPacketsMatched()
.- Returns:
- current value
-
getTableId
Return current value associated with the property corresponding toFlowTableAndStatisticsMap.getTableId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableAndStatisticsMap>> 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
-
withKey
Set the key value corresponding toFlowTableAndStatisticsMap.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setActiveFlows
public FlowTableAndStatisticsMapBuilder setActiveFlows(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value) Set the property corresponding toGenericTableStatistics.getActiveFlows()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketsLookedUp
public FlowTableAndStatisticsMapBuilder setPacketsLookedUp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value) Set the property corresponding toGenericTableStatistics.getPacketsLookedUp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketsMatched
public FlowTableAndStatisticsMapBuilder setPacketsMatched(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value) Set the property corresponding toGenericTableStatistics.getPacketsMatched()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
Set the property corresponding toFlowTableAndStatisticsMap.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowTableAndStatisticsMapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableAndStatisticsMap> 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 FlowTableAndStatisticsMapBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableAndStatisticsMap>> 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 newFlowTableAndStatisticsMap
instance.- Returns:
- A new
FlowTableAndStatisticsMap
instance.
-