Package org.apache.jackrabbit.oak.cache

Class CacheStats

java.lang.Object

javax.management.StandardMBean

org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

org.apache.jackrabbit.oak.cache.AbstractCacheStats

org.apache.jackrabbit.oak.cache.CacheStats

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, CacheStatsMBean

public class CacheStats
extends AbstractCacheStats

Cache statistics.

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

TYPE

Constructor Summary

Constructors

Constructor	Description
CacheStats(@NotNull org.apache.jackrabbit.guava.common.cache.Cache<?,?> cache, @NotNull String name, @Nullable org.apache.jackrabbit.guava.common.cache.Weigher<?,?> weigher, long maxWeight)	Construct the cache stats object.

Method Summary

Modifier and Type	Method	Description
long	estimateCurrentWeight()	Total weight of the complete cache.
protected org.apache.jackrabbit.guava.common.cache.CacheStats	getCurrentStats()	Call back invoked to retrieve the most recent CacheStats instance of the underlying cache.
long	getElementCount()	Get the number of elements/objects in the cache.
long	getMaxTotalWeight()	The maximum weight of entries the cache may contain.

Methods inherited from class org.apache.jackrabbit.oak.cache.AbstractCacheStats

cacheInfoAsString, getAverageLoadPenalty, getEvictionCount, getHitCount, getHitRate, getLoadCount, getLoadExceptionCount, getLoadExceptionRate, getLoadSuccessCount, getMissCount, getMissRate, getName, getRequestCount, getTotalLoadTime, resetStats, timeInWords

Methods inherited from class org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

getDescription, getDescription, getDescription, getDescription, getImpact, getParameterName

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CacheStats

public CacheStats(@NotNull
                  @NotNull org.apache.jackrabbit.guava.common.cache.Cache<?,?> cache,
                  @NotNull
                  @NotNull String name,
                  @Nullable
                  @Nullable org.apache.jackrabbit.guava.common.cache.Weigher<?,?> weigher,
                  long maxWeight)

Construct the cache stats object.

Parameters:

cache - the cache

name - the name of the cache

weigher - the weigher used to estimate the current weight

maxWeight - the maximum weight

Method Detail

getCurrentStats

protected org.apache.jackrabbit.guava.common.cache.CacheStats getCurrentStats()

Description copied from class: AbstractCacheStats

Call back invoked to retrieve the most recent CacheStats instance of the underlying cache.

Specified by:

getCurrentStats in class AbstractCacheStats

getElementCount

public long getElementCount()

Description copied from interface: CacheStatsMBean

Get the number of elements/objects in the cache.

Returns:

the number of elements

estimateCurrentWeight

public long estimateCurrentWeight()

Description copied from interface: CacheStatsMBean

Total weight of the complete cache. Depending on implementation it might be the amount of RAM taken by the cache

Returns:

to weight of the cache

getMaxTotalWeight

public long getMaxTotalWeight()

Description copied from interface: CacheStatsMBean

The maximum weight of entries the cache may contain.

Returns:

the maximum total weight of entries the cache may contain