AbstractCache (Jackrabbit Core 2.4.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jackrabbit.core.cache
Class AbstractCache

java.lang.Object
  org.apache.jackrabbit.core.cache.AbstractCache

All Implemented Interfaces:: Cache

Direct Known Subclasses:: ConcurrentCache

public abstract class AbstractCache
extends Object
implements Cache
extends Object
implements Cache

Abstract base class for managed Caches. This class uses atomic variables to track the current and maximum size of the cache, the cache access count and a possible CacheAccessListener instance.

A subclass should call the protected recordCacheAccess() method whenever the cache is accessed (even cache misses should be reported). The subclass should also use the recordSizeChange(long) method to record all changes in the cache size, and automatically evict excess items when the isTooBig() method returns true.

Constructor Summary
`AbstractCache()`

Method Summary
`void`	`dispose()`
`long`	`getAccessCount()` Get the number of accesses (get or set) until resetAccessCount was called.
`String`	`getCacheInfoAsString()` Gathers the stats of the cache for logging.
`long`	`getMaxMemorySize()` Get the current limit.
`long`	`getMemoryUsed()` Get the amount of used memory.
`long`	`getMissCount()` Get the number of cache misses.
`long`	`getTotalAccessCount()` Get the total number of cache accesses.
`protected boolean`	`isTooBig()` Checks whether the current estimate of the amount of memory used by this cache exceeds the allocated maximum amount of memory.
`protected void`	`recordCacheAccess()` Records a single cache access and calls the configured `CacheAccessListener` (if any) whenever the constant access interval has passed since the previous listener call.
`protected void`	`recordCacheMiss()`
`protected void`	`recordSizeChange(long delta)` Updates the current memory use estimate of this cache.
`void`	`resetAccessCount()` Reset the access counter.
`void`	`resetMissCount()` Reset the cache miss counter.
`void`	`setAccessListener(CacheAccessListener listener)` Set the cache access listener.
`void`	`setMaxMemorySize(long size)` Set the new memory limit.

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

Methods inherited from interface org.apache.jackrabbit.core.cache.Cache
`getElementCount`

Constructor Detail

AbstractCache

public AbstractCache()

Method Detail

isTooBig

protected boolean isTooBig()

Checks whether the current estimate of the amount of memory used by this cache exceeds the allocated maximum amount of memory.

Returns:: true if the cache size is too big, false otherwise

recordSizeChange

protected void recordSizeChange(long delta)

Updates the current memory use estimate of this cache.

Parameters:: delta - number of bytes added or removed

recordCacheAccess

protected void recordCacheAccess()

Records a single cache access and calls the configured CacheAccessListener (if any) whenever the constant access interval has passed since the previous listener call.