RICacheStatisticsMXBean (JSR107 Cache RI 1.1.1 API)

java.lang.Object
- org.jsr107.ri.management.RICacheStatisticsMXBean

All Implemented Interfaces:

Serializable, javax.cache.management.CacheStatisticsMXBean
```
public class RICacheStatisticsMXBean
extends Object
implements javax.cache.management.CacheStatisticsMXBean, Serializable
```
The reference implementation of CacheStatisticsMXBean.

Author:

Greg Luck

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RICacheStatisticsMXBean(javax.cache.Cache<?,?> cache)
Constructs a cache statistics object

Constructors
Constructor and Description
`RICacheStatisticsMXBean(javax.cache.Cache<?,?> cache)` Constructs a cache statistics object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGetTimeNano(long duration)` Increments the get time accumulator
`void`	`addPutTimeNano(long duration)` Increments the put time accumulator
`void`	`addRemoveTimeNano(long duration)` Increments the remove time accumulator
`void`	`clear()`
`float`	`getAverageGetTime()` The mean time to execute gets.
`float`	`getAveragePutTime()` The mean time to execute puts.
`float`	`getAverageRemoveTime()` The mean time to execute removes.
`long`	`getCacheEvictions()`
`long`	`getCacheGets()` The total number of requests to the cache.
`float`	`getCacheHitPercentage()` Returns cache hits as a percentage of total gets.
`long`	`getCacheHits()`
`long`	`getCacheMisses()`
`float`	`getCacheMissPercentage()` Returns cache misses as a percentage of total gets.
`long`	`getCachePuts()` The total number of puts to the cache.
`long`	`getCacheRemovals()` The total number of removals from the cache.
`long`	`getEntryCount()`
`void`	`increaseCacheEvictions(long number)` Increases the counter by the number specified.
`void`	`increaseCacheExpiries(long number)` Increases the counter by the number specified.
`void`	`increaseCacheHits(long number)` Increases the counter by the number specified.
`void`	`increaseCacheMisses(long number)` Increases the counter by the number specified.
`void`	`increaseCachePuts(long number)` Increases the counter by the number specified.
`void`	`increaseCacheRemovals(long number)` Increases the counter by the number specified.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RICacheStatisticsMXBean
```
public RICacheStatisticsMXBean(javax.cache.Cache<?,?> cache)
```
    Constructs a cache statistics object
    
    Parameters:
    
    cache - the associated cache
- Method Detail
  - clear
```
public void clear()
```
    Statistics will also automatically be cleared if internal counters overflow.
    
    Specified by:
    
    clear in interface javax.cache.management.CacheStatisticsMXBean
  - getEntryCount
```
public long getEntryCount()
```
    Returns:
    
    the entry count
  - getCacheHits
```
public long getCacheHits()
```
    Specified by:
    
    getCacheHits in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the number of hits
  - getCacheHitPercentage
```
public float getCacheHitPercentage()
```
    Returns cache hits as a percentage of total gets.
    
    Specified by:
    
    getCacheHitPercentage in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the percentage of successful hits, as a decimal
  - getCacheMisses
```
public long getCacheMisses()
```
    Specified by:
    
    getCacheMisses in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the number of misses
  - getCacheMissPercentage
```
public float getCacheMissPercentage()
```
    Returns cache misses as a percentage of total gets.
    
    Specified by:
    
    getCacheMissPercentage in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the percentage of accesses that failed to find anything
  - getCacheGets
```
public long getCacheGets()
```
    The total number of requests to the cache. This will be equal to the sum of the hits and misses.
    A "get" is an operation that returns the current or previous value.
    
    Specified by:
    
    getCacheGets in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the number of hits
  - getCachePuts
```
public long getCachePuts()
```
    The total number of puts to the cache.
    A put is counted even if it is immediately evicted. A replace includes a put and remove.
    
    Specified by:
    
    getCachePuts in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the number of hits
  - getCacheRemovals
```
public long getCacheRemovals()
```
    The total number of removals from the cache. This does not include evictions, where the cache itself initiates the removal to make space.
    A replace invcludes a put and remove.
    
    Specified by:
    
    getCacheRemovals in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the number of hits
  - getCacheEvictions
```
public long getCacheEvictions()
```
    Specified by:
    
    getCacheEvictions in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the number of evictions from the cache
  - getAverageGetTime
```
public float getAverageGetTime()
```
    The mean time to execute gets.
    
    Specified by:
    
    getAverageGetTime in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the time in milliseconds
  - getAveragePutTime
```
public float getAveragePutTime()
```
    The mean time to execute puts.
    
    Specified by:
    
    getAveragePutTime in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the time in milliseconds
  - getAverageRemoveTime
```
public float getAverageRemoveTime()
```
    The mean time to execute removes.
    
    Specified by:
    
    getAverageRemoveTime in interface javax.cache.management.CacheStatisticsMXBean
    
    Returns:
    
    the time in milliseconds
  - increaseCacheRemovals
```
public void increaseCacheRemovals(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number to increase the counter by
  - increaseCacheExpiries
```
public void increaseCacheExpiries(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number to increase the counter by
  - increaseCachePuts
```
public void increaseCachePuts(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number to increase the counter by
  - increaseCacheHits
```
public void increaseCacheHits(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number to increase the counter by
  - increaseCacheMisses
```
public void increaseCacheMisses(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number to increase the counter by
  - increaseCacheEvictions
```
public void increaseCacheEvictions(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number to increase the counter by
  - addGetTimeNano
```
public void addGetTimeNano(long duration)
```
    Increments the get time accumulator
    
    Parameters:
    
    duration - the time taken in nanoseconds
  - addPutTimeNano
```
public void addPutTimeNano(long duration)
```
    Increments the put time accumulator
    
    Parameters:
    
    duration - the time taken in nanoseconds
  - addRemoveTimeNano
```
public void addRemoveTimeNano(long duration)
```
    Increments the remove time accumulator
    
    Parameters:
    
    duration - the time taken in nanoseconds

Class RICacheStatisticsMXBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RICacheStatisticsMXBean

Method Detail

clear

getEntryCount

getCacheHits

getCacheHitPercentage

getCacheMisses

getCacheMissPercentage

getCacheGets

getCachePuts

getCacheRemovals

getCacheEvictions

getAverageGetTime

getAveragePutTime

getAverageRemoveTime

increaseCacheRemovals

increaseCacheExpiries

increaseCachePuts

increaseCacheHits

increaseCacheMisses

increaseCacheEvictions

addGetTimeNano

addPutTimeNano

addRemoveTimeNano