Package com.tangosol.net.cache

Class AbstractEvictionPolicy

java.lang.Object

com.tangosol.util.Base

com.tangosol.net.cache.AbstractEvictionPolicy

All Implemented Interfaces:

ConfigurableCacheMap.EvictionPolicy, MapListener, EventListener

public abstract class AbstractEvictionPolicy
extends Base
implements ConfigurableCacheMap.EvictionPolicy, MapListener

An abstract base class for custom cache eviction policies.

Author:

jh 2005.12.14

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.Base

Base.LoggingWriter

Field Summary

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_CONFIG, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Fields inherited from interface com.tangosol.util.MapListener

ASYNCHRONOUS, SYNCHRONOUS, VERSION_AWARE

Constructor Summary

Constructors

Constructor	Description
AbstractEvictionPolicy()

Method Summary

Modifier and Type	Method	Description
protected ConfigurableCacheMap	ensureCache(MapEvent evt)	Return the ConfigurableCacheMap that uses this eviction policy.
void	entryDeleted(MapEvent evt)	Invoked when a map entry has been removed.
void	entryInserted(MapEvent evt)	Invoked when a map entry has been inserted.
abstract void	entryUpdated(ConfigurableCacheMap.Entry entry)	This method is called to indicate that an entry has been either inserted or updated.
void	entryUpdated(MapEvent evt)	Invoked when a map entry has been updated.
protected ConfigurableCacheMap	getCache()	Return the ConfigurableCacheMap that uses this eviction policy.
protected ConfigurableCacheMap.Entry	getEntry(MapEvent evt)	Return the map entry associated with the given map event.
String	getName()	Obtain the name of the eviction policy.

Methods inherited from class com.tangosol.util.Base

azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mergeArray, mergeBooleanArray, mergeByteArray, mergeCharArray, mergeDoubleArray, mergeFloatArray, mergeIntArray, mergeLongArray, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.net.cache.ConfigurableCacheMap.EvictionPolicy

entryTouched, requestEviction

Methods inherited from interface com.tangosol.util.MapListener

characteristics, isAsynchronous, isSynchronous, isVersionAware, synchronous

Constructor Details

AbstractEvictionPolicy

public AbstractEvictionPolicy()

Method Details

getName

public String getName()

Obtain the name of the eviction policy. This is intended to be human readable for use in a monitoring tool; examples include "LRU" and "LFU".

Specified by:

getName in interface ConfigurableCacheMap.EvictionPolicy

Returns:

the name of the eviction policy

entryInserted

public void entryInserted(MapEvent evt)

Invoked when a map entry has been inserted.

Specified by:

entryInserted in interface MapListener

Parameters:

evt - the MapEvent carrying the insert information

entryUpdated

public void entryUpdated(MapEvent evt)

Invoked when a map entry has been updated.

Specified by:

entryUpdated in interface MapListener

Parameters:

evt - the MapEvent carrying the update information

entryDeleted

public void entryDeleted(MapEvent evt)

Invoked when a map entry has been removed.

Specified by:

entryDeleted in interface MapListener

Parameters:

evt - the MapEvent carrying the delete information

entryUpdated

public abstract void entryUpdated(ConfigurableCacheMap.Entry entry)

This method is called to indicate that an entry has been either inserted or updated.

Parameters:

entry - the Entry that has been inserted or updated

ensureCache

protected ConfigurableCacheMap ensureCache(MapEvent evt)

Return the ConfigurableCacheMap that uses this eviction policy.

If the ConfigurableCacheMap property has not been intialized, it is set to the ConfigurableCacheMap that raised the given event.

Parameters:

evt - the MapEvent raised by the ConfigurableCacheMap that uses this eviction policy

Returns:

the ConfigurableCacheMap that uses this eviction policy

getEntry

protected ConfigurableCacheMap.Entry getEntry(MapEvent evt)

Return the map entry associated with the given map event.

Parameters:

evt - a map event raised by the cache that uses this eviction policy

Returns:

the map entry associated with the given event

getCache

protected ConfigurableCacheMap getCache()

Return the ConfigurableCacheMap that uses this eviction policy. The ConfigurableCacheMap is set the first time a map event is processed by the eviction policy.

Returns:

the ConfigurableCacheMap or null if a map event has not yet been processed by this eviction policy