ColdBox Platform v3.8.0

coldbox.system.cache.util
Class CacheStats

WEB-INF.cftags.component
        extended by coldbox.system.cache.util.CacheStats
All Implemented Interfaces:
ICacheStats

public class CacheStats
extends WEB-INF.cftags.component

This object keeps the cache statistics

Constructor Summary
init(any<ICacheProvider> cacheProvider)
          Constructor
 
Method Summary
 void GCHit()
          Record a garbage collection hit
 void clearStatistics()
          Clear the stats
 void evictionHit()
          Record an eviction hit
 any<ICacheProvider> getAssociatedCache()
          Get the associated cache provider/manager of type: coldbox
 any getCachePerformanceRatio()
          Get the cache's performance ratio
 any getEvictionCount()
          Get the total cache eviction counts
 any getGarbageCollections()
          Get the cache garbage collections
 any getHits()
          Get the cache hits
 any getLastReapDatetime()
          Get the last reaping date of the cache
 any getMemento()
          Get the stats memento
 any getMisses()
          Get the cache misses
 any getObjectCount()
          Get the associated cache's live object count
 void hit()
          Record a hit
 void miss()
          Record a miss
 void setLastReapDatetime(string lastReapDatetime)
          Set when the last reaping date of the cache was done
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any<ICacheProvider> cacheProvider)
Constructor

Parameters:
cacheProvider - The associated cache manager/provider of type: coldbox.system.cache.ICacheProvider
Method Detail

GCHit

public void GCHit()
Record a garbage collection hit


clearStatistics

public void clearStatistics()
Clear the stats

Specified by:
clearStatistics in interface ICacheStats

evictionHit

public void evictionHit()
Record an eviction hit


getAssociatedCache

public any<ICacheProvider> getAssociatedCache()
Get the associated cache provider/manager of type: coldbox.system.cache.ICacheProvider


getCachePerformanceRatio

public any getCachePerformanceRatio()
Get the cache's performance ratio

Specified by:
getCachePerformanceRatio in interface ICacheStats

getEvictionCount

public any getEvictionCount()
Get the total cache eviction counts

Specified by:
getEvictionCount in interface ICacheStats

getGarbageCollections

public any getGarbageCollections()
Get the cache garbage collections

Specified by:
getGarbageCollections in interface ICacheStats

getHits

public any getHits()
Get the cache hits

Specified by:
getHits in interface ICacheStats

getLastReapDatetime

public any getLastReapDatetime()
Get the last reaping date of the cache

Specified by:
getLastReapDatetime in interface ICacheStats

getMemento

public any getMemento()
Get the stats memento


getMisses

public any getMisses()
Get the cache misses

Specified by:
getMisses in interface ICacheStats

getObjectCount

public any getObjectCount()
Get the associated cache's live object count

Specified by:
getObjectCount in interface ICacheStats

hit

public void hit()
Record a hit


miss

public void miss()
Record a miss


setLastReapDatetime

public void setLastReapDatetime(string lastReapDatetime)
Set when the last reaping date of the cache was done

Parameters:
lastReapDatetime

ColdBox Platform v3.8.0