CacheStatisticsImpl (Hazelcast Root 3.12.12 API)

java.lang.Object
- com.hazelcast.cache.impl.CacheStatisticsImpl

All Implemented Interfaces:

CacheStatistics

Direct Known Subclasses:

ClientCacheStatisticsImpl
```
public class CacheStatisticsImpl
extends Object
implements CacheStatistics
```
CacheStatistics implementation for ICache.
Statistics accumulated in this data object is published through MxBean as defined by spec.

See Also:

CacheMXBeanImpl

Field Summary

Fields
Modifier and Type	Field and Description
`protected CacheEntryCountResolver`	`cacheEntryCountResolver`
`protected long`	`creationTime` This field is not mutated (read only) so no need to define it as volatile.
`protected long`	`evictions`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`EVICTIONS`
`protected long`	`expiries`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`EXPIRIES`
`protected static float`	`FLOAT_HUNDRED`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`GET_CACHE_TIME_TAKEN_NANOS`
`protected long`	`getCacheTimeTakenNanos`
`protected long`	`hits`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`HITS`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`LAST_ACCESS_TIME`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`LAST_UPDATE_TIME`
`protected long`	`lastAccessTime`
`protected long`	`lastUpdateTime`
`protected long`	`misses`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`MISSES`
`protected static long`	`NANOSECONDS_IN_A_MICROSECOND`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`PUT_TIME_TAKEN_NANOS`
`protected long`	`puts`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`PUTS`
`protected long`	`putTimeTakenNanos`
`protected long`	`removals`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`REMOVALS`
`protected static AtomicLongFieldUpdater<CacheStatisticsImpl>`	`REMOVE_TIME_TAKEN_NANOS`
`protected long`	`removeTimeTakenNanos`

Constructor Summary

Constructors
Constructor and Description
`CacheStatisticsImpl(long creationTime)`
`CacheStatisticsImpl(long creationTime, CacheEntryCountResolver cacheEntryCountResolver)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGetTimeNanos(long duration)` Increments the getCache time accumulator.
`void`	`addPutTimeNanos(long duration)` Increments the put time accumulator.
`void`	`addRemoveTimeNanos(long duration)` Increments the remove time accumulator.
`void`	`clear()` Implementation of `CacheStatisticsMXBean.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()` The total number of evictions from the cache.
`long`	`getCacheExpiries()` The total number of expiries from the cache.
`long`	`getCacheGets()` The total number of requests to the cache.
`long`	`getCacheGetTimeTakenNanos()`
`float`	`getCacheHitPercentage()` This is a measure of cache efficiency.
`long`	`getCacheHits()` The number of get requests that were satisfied by the cache.
`long`	`getCacheMisses()` A miss is a get request that is not satisfied.
`float`	`getCacheMissPercentage()` Returns the percentage of cache accesses that did not find a requested entry in the cache.
`long`	`getCachePuts()` The total number of puts to the cache.
`long`	`getCachePutTimeTakenNanos()`
`long`	`getCacheRemovals()` The total number of removals from the cache.
`long`	`getCacheRemoveTimeTakenNanos()`
`long`	`getCreationTime()` Gets the cache creation time.
`long`	`getLastAccessTime()` Gets the last access time to cache.
`long`	`getLastUpdateTime()` Gets the last update time to cache.
`NearCacheStats`	`getNearCacheStatistics()` Gets the Near Cache statistics.
`long`	`getOwnedEntryCount()` Returns the owned entry count in the cache.
`void`	`increaseCacheEvictions()` Increases the counter by `1`.
`void`	`increaseCacheEvictions(long number)` Increases the counter by the number specified.
`void`	`increaseCacheExpiries()` Increases the counter by `1`.
`void`	`increaseCacheExpiries(long number)` Increases the counter by the number specified.
`void`	`increaseCacheHits()` Increases the counter by `1`.
`void`	`increaseCacheHits(long number)` Increases the counter by the number specified.
`void`	`increaseCacheMisses()` Increases the counter by `1`.
`void`	`increaseCacheMisses(long number)` Increases the counter by the number specified.
`void`	`increaseCachePuts()` Increases the counter by `1`.
`void`	`increaseCachePuts(long number)` Increases the counter by the number specified.
`void`	`increaseCacheRemovals()` Increases the counter by `1`.
`void`	`increaseCacheRemovals(long number)` Increases the counter by the number specified.
`void`	`setLastAccessTime(long time)` Sets the cache last access time as atomic if the given time is bigger than it.
`void`	`setLastUpdateTime(long time)` Sets the cache last update time as atomic if the given time is bigger than it.
`String`	`toString()`

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

- Field Detail
  - FLOAT_HUNDRED
```
protected static final float FLOAT_HUNDRED
```
    See Also:
    
    Constant Field Values
  - NANOSECONDS_IN_A_MICROSECOND
```
protected static final long NANOSECONDS_IN_A_MICROSECOND
```
    See Also:
    
    Constant Field Values
  - LAST_ACCESS_TIME
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> LAST_ACCESS_TIME
```
  - LAST_UPDATE_TIME
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> LAST_UPDATE_TIME
```
  - REMOVALS
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> REMOVALS
```
  - EXPIRIES
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> EXPIRIES
```
  - PUTS
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> PUTS
```
  - HITS
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> HITS
```
  - MISSES
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> MISSES
```
  - EVICTIONS
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> EVICTIONS
```
  - PUT_TIME_TAKEN_NANOS
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> PUT_TIME_TAKEN_NANOS
```
  - GET_CACHE_TIME_TAKEN_NANOS
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> GET_CACHE_TIME_TAKEN_NANOS
```
  - REMOVE_TIME_TAKEN_NANOS
```
protected static final AtomicLongFieldUpdater<CacheStatisticsImpl> REMOVE_TIME_TAKEN_NANOS
```
  - creationTime
```
protected long creationTime
```
    This field is not mutated (read only) so no need to define it as volatile.
  - lastAccessTime
```
protected volatile long lastAccessTime
```
  - lastUpdateTime
```
protected volatile long lastUpdateTime
```
  - removals
```
protected volatile long removals
```
  - expiries
```
protected volatile long expiries
```
  - puts
```
protected volatile long puts
```
  - hits
```
protected volatile long hits
```
  - misses
```
protected volatile long misses
```
  - evictions
```
protected volatile long evictions
```
  - putTimeTakenNanos
```
protected volatile long putTimeTakenNanos
```
  - getCacheTimeTakenNanos
```
protected volatile long getCacheTimeTakenNanos
```
  - removeTimeTakenNanos
```
protected volatile long removeTimeTakenNanos
```
  - cacheEntryCountResolver
```
protected final CacheEntryCountResolver cacheEntryCountResolver
```
- Constructor Detail
  - CacheStatisticsImpl
```
public CacheStatisticsImpl(long creationTime)
```
  - CacheStatisticsImpl
```
public CacheStatisticsImpl(long creationTime,
                           CacheEntryCountResolver cacheEntryCountResolver)
```
- Method Detail
  - getCreationTime
```
public long getCreationTime()
```
    Description copied from interface: CacheStatistics
    
    Gets the cache creation time.
    
    Specified by:
    
    getCreationTime in interface CacheStatistics
    
    Returns:
    
    the cache creation time
  - getLastAccessTime
```
public long getLastAccessTime()
```
    Description copied from interface: CacheStatistics
    
    Gets the last access time to cache.
    
    Specified by:
    
    getLastAccessTime in interface CacheStatistics
    
    Returns:
    
    the last access time to cache
  - getLastUpdateTime
```
public long getLastUpdateTime()
```
    Description copied from interface: CacheStatistics
    
    Gets the last update time to cache.
    
    Specified by:
    
    getLastUpdateTime in interface CacheStatistics
    
    Returns:
    
    the last update time to cache
  - getOwnedEntryCount
```
public long getOwnedEntryCount()
```
    Description copied from interface: CacheStatistics
    
    Returns the owned entry count in the cache.
    
    Specified by:
    
    getOwnedEntryCount in interface CacheStatistics
    
    Returns:
    
    the owned entry count in the cache
  - getCacheRemovals
```
public long getCacheRemovals()
```
    Description copied from interface: CacheStatistics
    
    The total number of removals from the cache. This does not include evictions, where the cache itself initiates the removal to make space.
    
    Specified by:
    
    getCacheRemovals in interface CacheStatistics
    
    Returns:
    
    the number of removals from the cache
  - getCacheExpiries
```
public long getCacheExpiries()
```
    The total number of expiries from the cache. An expiry may or may not be evicted. This number represents the entries that fail evaluation and may not include the entries which are not yet evaluated for expiry or not accessed.
    
    Returns:
    
    the number of expiries.
  - getCacheGets
```
public long getCacheGets()
```
    Description copied from interface: CacheStatistics
    
    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. It does not include checking for the existence of a key.
    In caches with multiple tiered storage, a get may be implemented as a get to the cache or to the first tier.
    
    Specified by:
    
    getCacheGets in interface CacheStatistics
    
    Returns:
    
    the number of gets to the cache
  - getCachePuts
```
public long getCachePuts()
```
    Description copied from interface: CacheStatistics
    
    The total number of puts to the cache.
    A put is counted even if it is immediately evicted.
    Replaces are where a put occurs which overrides an existing mapping, and they are counted as a put.
    
    Specified by:
    
    getCachePuts in interface CacheStatistics
    
    Returns:
    
    the number of puts to the cache
  - getCacheHits
```
public long getCacheHits()
```
    Description copied from interface: CacheStatistics
    
    The number of get requests that were satisfied by the cache.
    Cache.containsKey(Object) is not a get request for statistics purposes.
    In caches with multiple tiered storage, a hit may be implemented as a hit to the cache or to the first tier.
    For an EntryProcessor, a hit occurs when the key exists and an entry processor can be invoked against it, even if no methods of Cache.Entry or MutableEntry are called.
    
    Specified by:
    
    getCacheHits in interface CacheStatistics
    
    Returns:
    
    the number of hits (get requests that were satisfied by the cache)
  - getCacheMisses
```
public long getCacheMisses()
```
    Description copied from interface: CacheStatistics
    
    A miss is a get request that is not satisfied.
    In a simple cache, a miss occurs when the cache does not satisfy the request.
    Cache.containsKey(Object) is not a get request for statistics purposes.
    For an EntryProcessor, a miss occurs when the key does not exist and therefore an entry processor cannot be invoked against it.
    In caches with multiple tiered storage, a miss may be implemented as a miss to the cache or to the first tier.
    In a read-through cache, a miss is an absence of the key in the cache that will trigger a call to a CacheLoader. So it is still a miss even though the cache will load and return the value.
    Refer to the implementation for precise semantics.
    
    Specified by:
    
    getCacheMisses in interface CacheStatistics
    
    Returns:
    
    the number of misses (get requests that were not satisfied)
  - getCacheEvictions
```
public long getCacheEvictions()
```
    Description copied from interface: CacheStatistics
    
    The total number of evictions from the cache. An eviction is a removal initiated by the cache itself to free up space. An eviction is not treated as a removal and does not appear in the removal counts.
    
    Specified by:
    
    getCacheEvictions in interface CacheStatistics
    
    Returns:
    
    the total number of evictions from the cache
  - getCachePutTimeTakenNanos
```
public long getCachePutTimeTakenNanos()
```
  - getCacheGetTimeTakenNanos
```
public long getCacheGetTimeTakenNanos()
```
  - getCacheRemoveTimeTakenNanos
```
public long getCacheRemoveTimeTakenNanos()
```
  - getCacheHitPercentage
```
public float getCacheHitPercentage()
```
    Description copied from interface: CacheStatistics
    
    This is a measure of cache efficiency.
    It is calculated as: CacheStatistics.getCacheHits() divided by () * 100.
    
    Specified by:
    
    getCacheHitPercentage in interface CacheStatistics
    
    Returns:
    
    the percentage of successful hits as a decimal, such as 75
  - getCacheMissPercentage
```
public float getCacheMissPercentage()
```
    Description copied from interface: CacheStatistics
    
    Returns the percentage of cache accesses that did not find a requested entry in the cache.
    This is calculated as CacheStatistics.getCacheMisses() divided by CacheStatistics.getCacheGets() * 100.
    
    Specified by:
    
    getCacheMissPercentage in interface CacheStatistics
    
    Returns:
    
    the percentage of cache accesses that failed to find anything
  - getAverageGetTime
```
public float getAverageGetTime()
```
    Description copied from interface: CacheStatistics
    
    The mean time to execute gets.
    In a read-through cache, the time taken to load an entry on miss is not included in get time.
    
    Specified by:
    
    getAverageGetTime in interface CacheStatistics
    
    Returns:
    
    the mean time in microseconds to execute gets
  - getAveragePutTime
```
public float getAveragePutTime()
```
    Description copied from interface: CacheStatistics
    
    The mean time to execute puts.
    
    Specified by:
    
    getAveragePutTime in interface CacheStatistics
    
    Returns:
    
    the mean time in microseconds to execute puts
  - getAverageRemoveTime
```
public float getAverageRemoveTime()
```
    Description copied from interface: CacheStatistics
    
    The mean time to execute removes.
    
    Specified by:
    
    getAverageRemoveTime in interface CacheStatistics
    
    Returns:
    
    the mean time in microseconds to execute removes
  - clear
```
public void clear()
```
    Implementation of CacheStatisticsMXBean.clear().
    
    See Also:
    
    CacheStatisticsMXBean.clear()
  - setLastAccessTime
```
public void setLastAccessTime(long time)
```
    Sets the cache last access time as atomic if the given time is bigger than it.
    
    Parameters:
    
    time - time to set the cache last access time
  - setLastUpdateTime
```
public void setLastUpdateTime(long time)
```
    Sets the cache last update time as atomic if the given time is bigger than it.
    
    Parameters:
    
    time - time to set the cache last update time
  - increaseCacheRemovals
```
public void increaseCacheRemovals()
```
    Increases the counter by `1`.
  - increaseCacheRemovals
```
public void increaseCacheRemovals(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number by which the counter is increased.
  - increaseCacheExpiries
```
public void increaseCacheExpiries()
```
    Increases the counter by `1`.
  - increaseCacheExpiries
```
public void increaseCacheExpiries(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number by which the counter is increased.
  - increaseCachePuts
```
public void increaseCachePuts()
```
    Increases the counter by `1`.
  - increaseCachePuts
```
public void increaseCachePuts(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number by which the counter is increased.
  - increaseCacheHits
```
public void increaseCacheHits()
```
    Increases the counter by `1`.
  - increaseCacheHits
```
public void increaseCacheHits(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number by which the counter is increased.
  - increaseCacheMisses
```
public void increaseCacheMisses()
```
    Increases the counter by `1`.
  - increaseCacheMisses
```
public void increaseCacheMisses(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number by which the counter is increased.
  - increaseCacheEvictions
```
public void increaseCacheEvictions()
```
    Increases the counter by `1`.
  - increaseCacheEvictions
```
public void increaseCacheEvictions(long number)
```
    Increases the counter by the number specified.
    
    Parameters:
    
    number - the number by which the counter is increased.
  - addGetTimeNanos
```
public void addGetTimeNanos(long duration)
```
    Increments the getCache time accumulator.
    
    Parameters:
    
    duration - the time taken in nanoseconds.
  - addPutTimeNanos
```
public void addPutTimeNanos(long duration)
```
    Increments the put time accumulator.
    
    Parameters:
    
    duration - the time taken in nanoseconds.
  - addRemoveTimeNanos
```
public void addRemoveTimeNanos(long duration)
```
    Increments the remove time accumulator.
    
    Parameters:
    
    duration - the time taken in nanoseconds.
  - getNearCacheStatistics
```
public NearCacheStats getNearCacheStatistics()
```
    Description copied from interface: CacheStatistics
    
    Gets the Near Cache statistics.
    
    Specified by:
    
    getNearCacheStatistics in interface CacheStatistics
    
    Returns:
    
    the Near Cache statistics
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CacheStatisticsImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLOAT_HUNDRED

NANOSECONDS_IN_A_MICROSECOND

LAST_ACCESS_TIME

LAST_UPDATE_TIME

REMOVALS

EXPIRIES

PUTS

HITS

MISSES

EVICTIONS

PUT_TIME_TAKEN_NANOS

GET_CACHE_TIME_TAKEN_NANOS

REMOVE_TIME_TAKEN_NANOS

creationTime

lastAccessTime

lastUpdateTime

removals

expiries

puts

hits

misses

evictions

putTimeTakenNanos

getCacheTimeTakenNanos

removeTimeTakenNanos

cacheEntryCountResolver

Constructor Detail

CacheStatisticsImpl

CacheStatisticsImpl

Method Detail

getCreationTime

getLastAccessTime

getLastUpdateTime

getOwnedEntryCount

getCacheRemovals

getCacheExpiries

getCacheGets

getCachePuts

getCacheHits

getCacheMisses

getCacheEvictions

getCachePutTimeTakenNanos

getCacheGetTimeTakenNanos

getCacheRemoveTimeTakenNanos

getCacheHitPercentage

getCacheMissPercentage

getAverageGetTime

getAveragePutTime

getAverageRemoveTime

clear

setLastAccessTime

setLastUpdateTime

increaseCacheRemovals

increaseCacheRemovals

increaseCacheExpiries

increaseCacheExpiries

increaseCachePuts

increaseCachePuts

increaseCacheHits

increaseCacheHits

increaseCacheMisses

increaseCacheMisses

increaseCacheEvictions

increaseCacheEvictions

addGetTimeNanos

addPutTimeNanos

addRemoveTimeNanos

getNearCacheStatistics

toString