Class TableStatsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.multipart.reply.table.TableStatsBuilder
Class that builds
TableStats
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:
TableStats createTableStats(int fooXyzzy, int barBaz) {
return new TableStatsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of TableStats, 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.TableStatsBuilder
(TableStats base) Construct a builder initialized with state from specifiedTableStats
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<TableStats> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableStats>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull TableStats
build()
A newTableStats
instance.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toTableStats.getActiveCount()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toTableStats.getLookupCount()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toTableStats.getMatchedCount()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toTableStats.getMaxEntries()
.getName()
Return current value associated with the property corresponding toTableStats.getName()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toTableStats.getNwDstMask()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toTableStats.getNwSrcMask()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toTableStats.getTableId()
.Return current value associated with the property corresponding toTableStats.getWildcards()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableStats>> augmentationType) Remove an augmentation from this builder's product.setActiveCount
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toTableStats.getActiveCount()
to the specified value.setLookupCount
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toTableStats.getLookupCount()
to the specified value.setMatchedCount
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toTableStats.getMatchedCount()
to the specified value.setMaxEntries
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toTableStats.getMaxEntries()
to the specified value.Set the property corresponding toTableStats.getName()
to the specified value.setNwDstMask
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toTableStats.getNwDstMask()
to the specified value.setNwSrcMask
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toTableStats.getNwSrcMask()
to the specified value.setTableId
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toTableStats.getTableId()
to the specified value.setWildcards
(FlowWildcardsV10 value) Set the property corresponding toTableStats.getWildcards()
to the specified value.
-
Constructor Details
-
TableStatsBuilder
public TableStatsBuilder()Construct an empty builder. -
TableStatsBuilder
Construct a builder initialized with state from specifiedTableStats
.- Parameters:
base
- TableStats from which the builder should be initialized
-
-
Method Details
-
getActiveCount
public org.opendaylight.yangtools.yang.common.Uint32 getActiveCount()Return current value associated with the property corresponding toTableStats.getActiveCount()
.- Returns:
- current value
-
getLookupCount
public org.opendaylight.yangtools.yang.common.Uint64 getLookupCount()Return current value associated with the property corresponding toTableStats.getLookupCount()
.- Returns:
- current value
-
getMatchedCount
public org.opendaylight.yangtools.yang.common.Uint64 getMatchedCount()Return current value associated with the property corresponding toTableStats.getMatchedCount()
.- Returns:
- current value
-
getMaxEntries
public org.opendaylight.yangtools.yang.common.Uint32 getMaxEntries()Return current value associated with the property corresponding toTableStats.getMaxEntries()
.- Returns:
- current value
-
getName
Return current value associated with the property corresponding toTableStats.getName()
.- Returns:
- current value
-
getNwDstMask
public org.opendaylight.yangtools.yang.common.Uint8 getNwDstMask()Return current value associated with the property corresponding toTableStats.getNwDstMask()
.- Returns:
- current value
-
getNwSrcMask
public org.opendaylight.yangtools.yang.common.Uint8 getNwSrcMask()Return current value associated with the property corresponding toTableStats.getNwSrcMask()
.- Returns:
- current value
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()Return current value associated with the property corresponding toTableStats.getTableId()
.- Returns:
- current value
-
getWildcards
Return current value associated with the property corresponding toTableStats.getWildcards()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableStats>> 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
-
setActiveCount
Set the property corresponding toTableStats.getActiveCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLookupCount
Set the property corresponding toTableStats.getLookupCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchedCount
Set the property corresponding toTableStats.getMatchedCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxEntries
Set the property corresponding toTableStats.getMaxEntries()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
Set the property corresponding toTableStats.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNwDstMask
Set the property corresponding toTableStats.getNwDstMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNwSrcMask
Set the property corresponding toTableStats.getNwSrcMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
Set the property corresponding toTableStats.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWildcards
Set the property corresponding toTableStats.getWildcards()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TableStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableStats> 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 TableStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableStats>> 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 newTableStats
instance.- Returns:
- A new
TableStats
instance.
-