Skip navigation links

Oracle® Coherence Java API Reference
Release 3.6.0.0

E15725-01


com.tangosol.net.cache
Class OldCache

java.lang.Object
  extended by java.util.AbstractMap
      extended by com.tangosol.util.SafeHashMap
          extended by com.tangosol.net.cache.OldCache

All Implemented Interfaces:
CacheMap, ConfigurableCacheMap, ObservableMap, Serializable, Cloneable, Map
Direct Known Subclasses:
LocalCache

Deprecated. As of Coherence 3.1, use LocalCache instead

public class OldCache
extends SafeHashMap
implements ObservableMap, ConfigurableCacheMap

A generic cache manager.

The implementation is thread safe and uses a combination of Most Recently Used (MRU) and Most Frequently Used (MFU) caching strategies.

The cache is size-limited, which means that once it reaches its maximum size ("high-water mark") it prunes itself (to its "low-water mark"). The cache high- and low-water-marks are measured in terms of "units", and each cached item by default uses one unit. All of the cache constructors, except for the default constructor, require the maximum number of units to be passed in. To change the number of units that each cache entry uses, either set the Units property of the cache entry, or extend the Cache implementation so that the inner Entry class calculates its own unit size. To determine the current, high-water and low-water sizes of the cache, use the cache object's Units, HighUnits and LowUnits properties. The HighUnits and LowUnits properties can be changed, even after the cache is in use. To specify the LowUnits value as a percentage when constructing the cache, use the extended constructor taking the percentage-prune-level.

Each cached entry expires after one hour by default. To alter this behavior, use a constructor that takes the expiry-millis; for example, an expiry-millis value of 10000 will expire entries after 10 seconds. The ExpiryDelay property can also be set once the cache is in use, but it will not affect the expiry of previously cached items.

The cache can optionally be flushed on a periodic basis by setting the FlushDelay property or scheduling a specific flush time by setting the FlushTime property.

Cache hit statistics can be obtained from the CacheHits, CacheMisses, HitProbability, KeyHitProbability and CompositeHitProbability read-only properties. The statistics can be reset by invoking resetHitStatistics. The statistics are automatically reset when the cache is cleared (the clear method).

The OldCache implements the ObservableMap interface, meaning it provides event notifications to any interested listener for each insert, update and delete, including those that occur when the cache is pruned or entries are automatically expired.

This implementation is designed to support extension through inheritence. When overriding the inner Entry class, the OldCache.instantiateEntry factory method must be overridden to instantiate the correct Entry sub-class. To override the one-unit-per-entry default behavior, extend the inner Entry class and override the calculateUnits method.

Author:
cp 2001.04.19, cp 2005.05.18 moved to com.tangosol.net.cache package

Nested Class Summary
 class OldCache.Entry
          Deprecated. A holder for a cached value.
protected  class OldCache.EntrySet
          Deprecated. A set of entries backed by this map.
static interface OldCache.EvictionPolicy
          Deprecated. An eviction policy is an object that the cache provides with access information, and when requested, the eviction policy selects and evicts entries from the cache.
static class OldCache.InternalEvictionPolicy
          Deprecated. The InternalEvictionPolicy represents a pluggable eviction policy for the non-pluggable built-in (internal) eviction policies supported by this cache implementation.
static class OldCache.InternalUnitCalculator
          Deprecated. The InternalUnitCalculator represents a pluggable UnitCalculator for the non-pluggable built-in (internal) UnitCalculator implementation provided by this cache implementation.
protected  class OldCache.KeySet
          Deprecated. A set of entries backed by this map.
static interface OldCache.UnitCalculator
          Deprecated. A unit calculator is an object that can calculate the cost of caching an object.
protected  class OldCache.ValuesCollection
          Deprecated. A collection of values backed by this map.

 

Field Summary
static int DEFAULT_EXPIRE
          Deprecated. By default, the cache entries expire after one hour.
static int DEFAULT_FLUSH
          Deprecated. as of Coherence 3.5
static double DEFAULT_PRUNE
          Deprecated. By default, when the cache prunes, it reduces its entries by this percentage.
static int DEFAULT_UNITS
          Deprecated. By default, the cache size (in units).
static int EVICTION_POLICY_EXTERNAL
          Deprecated. The cache can prune using an external eviction policy.
static int EVICTION_POLICY_HYBRID
          Deprecated. By default, the cache prunes based on a hybrid LRU+LFU algorithm.
static int EVICTION_POLICY_LFU
          Deprecated. The cache can prune based on a pure Least Frequently Used (LFU) algorithm.
static int EVICTION_POLICY_LRU
          Deprecated. The cache can prune based on a pure Least Recently Used (LRU) algorithm.
static OldCache.UnitCalculator INSTANCE_BINARY
          Deprecated. The UnitCalculator object that measures the bytes used by entries.
static OldCache.UnitCalculator INSTANCE_FIXED
          Deprecated. The UnitCalculator object that counts each entry as one unit.
static OldCache.EvictionPolicy INSTANCE_HYBRID
          Deprecated. The EvictionPolicy object for the Hybrid eviction algorithm.
static OldCache.EvictionPolicy INSTANCE_LFU
          Deprecated. The EvictionPolicy object for the Least Frequently Used (LFU) eviction algorithm.
static OldCache.EvictionPolicy INSTANCE_LRU
          Deprecated. The EvictionPolicy object for the Least Recently Used (LRU) eviction algorithm.
protected  LongArray m_arrayExpiry
          Deprecated. Array of set of keys, indexed by the time of expiry.
protected  ConfigurableCacheMap.UnitCalculator m_calculator
          Deprecated. The external unit calculator.
protected  int m_cAvgTouch
          Deprecated. For a prune cycle, this value is the average number of touches that an entry should have.
protected  long m_cCurUnits
          Deprecated. The current number of units in the cache.
protected  int m_cExpiryDelay
          Deprecated. The number of milliseconds that a value will live in the cache.
protected  long m_cMaxUnits
          Deprecated. The number of units to allow the cache to grow to before pruning.
protected  long m_cPruneUnits
          Deprecated. The number of units to prune the cache down to.
protected  double m_dflPruneLevel
          Deprecated. The percentage of the total number of units that will remain after the cache manager prunes the cache (i.e. this is the "low water mark" value); this value is in the range 0.0 to 1.0.
protected  boolean m_fIncrementalEvict
          Deprecated. Specifies whether or not this cache will incrementally evict.
protected  Iterator m_iterEvict
          Deprecated. For deferred eviction, iterator of entries to evict.
protected  MapListenerSupport m_listenerSupport
          Deprecated. The MapListenerSupport object.
protected  long m_lLastPrune
          Deprecated. The last time that a prune was run.
protected  long m_lNextFlush
          Deprecated. The time before which a expired-entries flush will not be performed.
protected  int m_nCalculatorType
          Deprecated. The type of unit calculator employed by the cache; one of the UNIT_CALCULATOR_* enumerated values.
protected  int m_nEvictionType
          Deprecated. The type of eviction policy employed by the cache; one of the EVICTION_POLICY_* enumerated values.
protected  int m_nUnitFactor
          Deprecated. The unit factor.
protected  ConfigurableCacheMap.EvictionPolicy m_policy
          Deprecated. The eviction policy; for eviction type EVICTION_POLICY_EXTERNAL.
protected  SimpleCacheStatistics m_stats
          Deprecated. The CacheStatistics object maintained by this cache.
static int UNIT_CALCULATOR_BINARY
          Deprecated. Specifies a unit calculator that assigns an object a weight equal to the number of bytes of memory required to cache the object.
static int UNIT_CALCULATOR_EXTERNAL
          Deprecated. Specifies a external (custom) unit calculator implementation.
static int UNIT_CALCULATOR_FIXED
          Deprecated. Specifies the default unit calculator that weighs all entries equally as 1.

 

Fields inherited from class com.tangosol.util.SafeHashMap
BIGGEST_MODULO, DEFAULT_GROWTHRATE, DEFAULT_INITIALSIZE, DEFAULT_LOADFACTOR, m_aeBucket, m_cCapacity, m_cEntries, m_colValues, m_flGrowthRate, m_flLoadFactor, m_oIterActive, m_setEntries, m_setKeys, PRIME_MODULO, RESIZING

 

Fields inherited from interface com.tangosol.net.cache.CacheMap
EXPIRY_DEFAULT, EXPIRY_NEVER

 

Constructor Summary
OldCache()
          Deprecated. Construct the cache manager.
OldCache(int cUnits)
          Deprecated. Construct the cache manager.
OldCache(int cUnits, int cExpiryMillis)
          Deprecated. Construct the cache manager.
OldCache(int cUnits, int cExpiryMillis, double dflPruneLevel)
          Deprecated. Construct the cache manager.

 

Method Summary
 void addMapListener(MapListener listener)
          Deprecated. Add a standard map listener that will receive all events (inserts, updates, deletes) that occur against the map, with the key, old-value and new-value included.
 void addMapListener(MapListener listener, Filter filter, boolean fLite)
          Deprecated. Add a map listener that receives events based on a filter evaluation.
 void addMapListener(MapListener listener, Object oKey, boolean fLite)
          Deprecated. Add a map listener for a specific key.
protected  void adjustUnits(int cDelta)
          Deprecated. Adjust current size.
protected  void checkFlush()
          Deprecated. as of Coherence 3.5, use evict()
protected  void checkSize()
          Deprecated. Check if the cache is too big, and if it is prune it by discarding the lowest priority cache entries.
 void clear()
          Deprecated. Remove everything from the cache.
protected  void configureEviction(int nType, ConfigurableCacheMap.EvictionPolicy policy)
          Deprecated. Configure the eviction type and policy.
protected  void configureUnitCalculator(int nType, ConfigurableCacheMap.UnitCalculator calculator)
          Deprecated. Configure the unit calculator type and implementation.
 boolean containsKey(Object key)
          Deprecated. Returns true if the cache contains the specified key.
protected  void dispatchEvent(MapEvent evt)
          Deprecated. Dispatch the passed event.
 void evict()
          Deprecated. Evict all entries from the cache that are no longer valid, and potentially prune the cache size if the cache is size-limited and its size is above the caching low water mark.
 void evict(Object oKey)
          Deprecated. Evict a specified key from the cache, as if it had expired from the cache.
 void evictAll(Collection colKeys)
          Deprecated. Evict the specified keys from the cache, as if they had each expired from the cache.
 Object get(Object oKey)
          Deprecated. If the specified item is in the cache, return it.
 Map getAll(Collection colKeys)
          Deprecated. Get all the specified keys, if they are in the cache.
 ConfigurableCacheMap.Entry getCacheEntry(Object oKey)
          Deprecated. Locate a cache Entry in the cache based on its key.
 long getCacheHits()
          Deprecated. Determine the rough number of cache hits since the cache statistics were last reset.
 long getCacheMisses()
          Deprecated. Determine the rough number of cache misses since the cache statistics were last reset.
 CacheStatistics getCacheStatistics()
          Deprecated. Returns the CacheStatistics for this cache.
 SafeHashMap.Entry getEntry(Object oKey)
          Deprecated. Locate an Entry in the hash map based on its key.
protected  SafeHashMap.Entry getEntryInternal(Object oKey)
          Deprecated. Locate an Entry in the hash map based on its key.
 ConfigurableCacheMap.EvictionPolicy getEvictionPolicy()
          Deprecated. Obtain the current EvictionPolicy used by the cache.
 int getEvictionType()
          Deprecated. Determine the current eviction type.
 int getExpiryDelay()
          Deprecated. Determine the default "time to live" for each individual cache entry.
 int getFlushDelay()
          Deprecated. Determine the delay between cache flushes.
 long getFlushTime()
          Deprecated. as of Coherence 3.5
 int getHighUnits()
          Deprecated. Determine the limit of the cache size in units.
 double getHitProbability()
          Deprecated. Determine the rough probability (0 <= p <= 1) that any particular get(java.lang.Object) invocation will be satisfied by an existing entry in the cache, based on the statistics collected since the last reset of the cache statistics.
 int getLowUnits()
          Deprecated. Determine the point to which the cache will shrink when it prunes.
protected  MapListenerSupport getMapListenerSupport()
          Deprecated. Accessor for the MapListenerSupport for sub-classes.
 ConfigurableCacheMap.UnitCalculator getUnitCalculator()
          Deprecated. Obtain the current UnitCalculator used by the cache.
 int getUnitCalculatorType()
          Deprecated. Determine the current unit calculator type.
 int getUnitFactor()
          Deprecated. Determine the factor by which the Units, LowUnits and HighUnits properties are adjusted.
 int getUnits()
          Deprecated. Determine the number of units that the cache currently stores.
protected  boolean hasListeners()
          Deprecated. Determine if the OverflowMap has any listeners at all.
protected  SafeHashMap.Entry instantiateEntry()
          Deprecated. Factory method.
protected  SafeHashMap.EntrySet instantiateEntrySet()
          Deprecated. Factory pattern.
protected  SafeHashMap.KeySet instantiateKeySet()
          Deprecated. Factory pattern.
protected  MapEvent instantiateMapEvent(int nId, Object oKey, Object oValueOld, Object oValueNew)
          Deprecated. Factory pattern: instantiate a new MapEvent corresponding to the specified parameters.
protected  SafeHashMap.ValuesCollection instantiateValuesCollection()
          Deprecated. Factory pattern.
 boolean isIncrementalEviction()
          Deprecated. Determine if incremental eviction is enabled.
protected  void prune()
          Deprecated. Prune the cache by discarding the lowest priority cache entries.
 Object put(Object oKey, Object oValue)
          Deprecated. Store a value in the cache.
 Object put(Object oKey, Object oValue, long cMillis)
          Deprecated. Store a value in the cache that will be automatically evicted according to the specified expiration value.
 Object remove(Object oKey)
          Deprecated. Remove an entry from the cache.
protected  void removeExpired(OldCache.Entry entry, boolean fRemoveInternal)
          Deprecated. Remove an entry because it has expired.
 void removeMapListener(MapListener listener)
          Deprecated. Remove a standard map listener that previously signed up for all events.
 void removeMapListener(MapListener listener, Filter filter)
          Deprecated. Remove a map listener that previously signed up for events based on a filter evaluation.
 void removeMapListener(MapListener listener, Object oKey)
          Deprecated. Remove a map listener that previously signed up for events about a specific key.
 void resetHitStatistics()
          Deprecated. Reset the cache statistics.
 void setEvictionPolicy(ConfigurableCacheMap.EvictionPolicy policy)
          Deprecated. Set the EvictionPolicy for the cache to use.
 void setEvictionType(int nType)
          Deprecated. Specify the eviction type for the cache.
 void setExpiryDelay(int cMillis)
          Deprecated. Specify the default "time to live" for cache entries.
 void setFlushDelay(int cMillis)
          Deprecated. Specify the delay between cache flushes.
 void setFlushTime(long lMillis)
          Deprecated. as of Coherence 3.5
 void setHighUnits(int cMax)
          Deprecated. Update the maximum size of the cache in units.
 void setIncrementalEviction(boolean fIncrementalEvict)
          Deprecated. Sepcify whether incremental eviction is enabled.
 void setLowUnits(int cMin)
          Deprecated. Specify the point to which the cache will shrink when it prunes.
 void setUnitCalculator(ConfigurableCacheMap.UnitCalculator calculator)
          Deprecated. Set the UnitCalculator for the cache to use.
 void setUnitCalculatorType(int nType)
          Deprecated. Specify the unit calculator type for the cache.
 void setUnitFactor(int nFactor)
          Deprecated. Determine the factor by which the Units, LowUnits and HighUnits properties are adjusted.
 int size()
          Deprecated. Returns the number of key-value mappings in this map.
protected static int toExternalUnits(long cUnits, int nFactor)
          Deprecated. Convert from an internal 64-bit unit value to an external 32-bit unit value using the configured units factor.
protected static long toInternalUnits(int cUnits, int nFactor)
          Deprecated. Convert from an internal 64-bit unit value to an external 32-bit unit value using the configured units factor.
 String toString()
          Deprecated. For debugging purposes, format the contents of the cache as a String.

 

Methods inherited from class com.tangosol.util.SafeHashMap
clone, cloneEntryList, entrySet, getBucketIndex, getStableBucketArray, grow, instantiateEntry, isActiveIterator, isEmpty, iteratorActivated, iteratorDeactivated, keySet, removeEntryInternal, values

 

Methods inherited from class java.util.AbstractMap
containsValue, equals, hashCode, putAll

 

Field Detail

DEFAULT_UNITS

public static final int DEFAULT_UNITS
Deprecated. 
By default, the cache size (in units).
See Also:
Constant Field Values

DEFAULT_EXPIRE

public static final int DEFAULT_EXPIRE
Deprecated. 
By default, the cache entries expire after one hour.
See Also:
Constant Field Values

DEFAULT_FLUSH

public static final int DEFAULT_FLUSH
Deprecated. as of Coherence 3.5
By default, expired cache entries are flushed on a minute interval.
See Also:
Constant Field Values

DEFAULT_PRUNE

public static final double DEFAULT_PRUNE
Deprecated. 
By default, when the cache prunes, it reduces its entries by this percentage.
See Also:
Constant Field Values

EVICTION_POLICY_HYBRID

public static final int EVICTION_POLICY_HYBRID
Deprecated. 
By default, the cache prunes based on a hybrid LRU+LFU algorithm.
See Also:
Constant Field Values

EVICTION_POLICY_LRU

public static final int EVICTION_POLICY_LRU
Deprecated. 
The cache can prune based on a pure Least Recently Used (LRU) algorithm.
See Also:
Constant Field Values

EVICTION_POLICY_LFU

public static final int EVICTION_POLICY_LFU
Deprecated. 
The cache can prune based on a pure Least Frequently Used (LFU) algorithm.
See Also:
Constant Field Values

EVICTION_POLICY_EXTERNAL

public static final int EVICTION_POLICY_EXTERNAL
Deprecated. 
The cache can prune using an external eviction policy.
See Also:
Constant Field Values

UNIT_CALCULATOR_FIXED

public static final int UNIT_CALCULATOR_FIXED
Deprecated. 
Specifies the default unit calculator that weighs all entries equally as 1.
See Also:
Constant Field Values

UNIT_CALCULATOR_BINARY

public static final int UNIT_CALCULATOR_BINARY
Deprecated. 
Specifies a unit calculator that assigns an object a weight equal to the number of bytes of memory required to cache the object.
See Also:
BinaryMemoryCalculator, Constant Field Values

UNIT_CALCULATOR_EXTERNAL

public static final int UNIT_CALCULATOR_EXTERNAL
Deprecated. 
Specifies a external (custom) unit calculator implementation.
See Also:
Constant Field Values

INSTANCE_HYBRID

public static final OldCache.EvictionPolicy INSTANCE_HYBRID
Deprecated. 
The EvictionPolicy object for the Hybrid eviction algorithm.

INSTANCE_LRU

public static final OldCache.EvictionPolicy INSTANCE_LRU
Deprecated. 
The EvictionPolicy object for the Least Recently Used (LRU) eviction algorithm.

INSTANCE_LFU

public static final OldCache.EvictionPolicy INSTANCE_LFU
Deprecated. 
The EvictionPolicy object for the Least Frequently Used (LFU) eviction algorithm.

INSTANCE_FIXED

public static final OldCache.UnitCalculator INSTANCE_FIXED
Deprecated. 
The UnitCalculator object that counts each entry as one unit.

INSTANCE_BINARY

public static final OldCache.UnitCalculator INSTANCE_BINARY
Deprecated. 
The UnitCalculator object that measures the bytes used by entries. This is intended for caches that manage binary data.

m_cCurUnits

protected volatile long m_cCurUnits
Deprecated. 
The current number of units in the cache. A unit is an undefined means of measuring cached values, and must be 0 or positive. The particular Entry implementation being used defines the meaning of unit.

m_cMaxUnits

protected long m_cMaxUnits
Deprecated. 
The number of units to allow the cache to grow to before pruning.

m_dflPruneLevel

protected double m_dflPruneLevel
Deprecated. 
The percentage of the total number of units that will remain after the cache manager prunes the cache (i.e. this is the "low water mark" value); this value is in the range 0.0 to 1.0.

m_cPruneUnits

protected long m_cPruneUnits
Deprecated. 
The number of units to prune the cache down to.

m_nUnitFactor

protected int m_nUnitFactor
Deprecated. 
The unit factor.

m_cExpiryDelay

protected int m_cExpiryDelay
Deprecated. 
The number of milliseconds that a value will live in the cache. Zero indicates no timeout.

m_lNextFlush

protected volatile long m_lNextFlush
Deprecated. 
The time before which a expired-entries flush will not be performed.

m_stats

protected SimpleCacheStatistics m_stats
Deprecated. 
The CacheStatistics object maintained by this cache.

m_listenerSupport

protected MapListenerSupport m_listenerSupport
Deprecated. 
The MapListenerSupport object.

m_nEvictionType

protected int m_nEvictionType
Deprecated. 
The type of eviction policy employed by the cache; one of the EVICTION_POLICY_* enumerated values.

m_policy

protected ConfigurableCacheMap.EvictionPolicy m_policy
Deprecated. 
The eviction policy; for eviction type EVICTION_POLICY_EXTERNAL.

m_nCalculatorType

protected int m_nCalculatorType
Deprecated. 
The type of unit calculator employed by the cache; one of the UNIT_CALCULATOR_* enumerated values.

m_calculator

protected ConfigurableCacheMap.UnitCalculator m_calculator
Deprecated. 
The external unit calculator.

m_arrayExpiry

protected LongArray m_arrayExpiry
Deprecated. 
Array of set of keys, indexed by the time of expiry.
Since:
Coherence 3.5

m_lLastPrune

protected long m_lLastPrune
Deprecated. 
The last time that a prune was run. This value is used by the hybrid eviction policy.
Since:
Coherence 3.5

m_cAvgTouch

protected int m_cAvgTouch
Deprecated. 
For a prune cycle, this value is the average number of touches that an entry should have. This value is used by the hybrid eviction policy.
Since:
Coherence 3.5

m_iterEvict

protected Iterator m_iterEvict
Deprecated. 
For deferred eviction, iterator of entries to evict. If null, then there are no entries with deferred eviction.
Since:
Coherence 3.5

m_fIncrementalEvict

protected boolean m_fIncrementalEvict
Deprecated. 
Specifies whether or not this cache will incrementally evict.

Constructor Detail

OldCache

public OldCache()
Deprecated. 
Construct the cache manager.

OldCache

public OldCache(int cUnits)
Deprecated. 
Construct the cache manager.
Parameters:
cUnits - the number of units that the cache manager will cache before pruning the cache

OldCache

public OldCache(int cUnits,
                int cExpiryMillis)
Deprecated. 
Construct the cache manager.
Parameters:
cUnits - the number of units that the cache manager will cache before pruning the cache
cExpiryMillis - the number of milliseconds that each cache entry lives before being automatically expired

OldCache

public OldCache(int cUnits,
                int cExpiryMillis,
                double dflPruneLevel)
Deprecated. 
Construct the cache manager.
Parameters:
cUnits - the number of units that the cache manager will cache before pruning the cache
cExpiryMillis - the number of milliseconds that each cache entry lives before being automatically expired
dflPruneLevel - the percentage of the total number of units that will remain after the cache manager prunes the cache (i.e. this is the "low water mark" value); this value is in the range 0.0 to 1.0

Method Detail

size

public int size()
Deprecated. 
Returns the number of key-value mappings in this map.
Specified by:
size in interface Map
Overrides:
size in class SafeHashMap
Returns:
the number of key-value mappings in this map

containsKey

public boolean containsKey(Object key)
Deprecated. 
Returns true if the cache contains the specified key.
Specified by:
containsKey in interface Map
Overrides:
containsKey in class SafeHashMap
Parameters:
key - key whose presence in this map is to be tested
Returns:
true if this map contains a mapping for the specified key

get

public Object get(Object oKey)
Deprecated. 
If the specified item is in the cache, return it.
Specified by:
get in interface Map
Overrides:
get in class SafeHashMap
Parameters:
oKey - the key to the desired cached item
Returns:
the desired Object if it is in the cache, otherwise null
See Also:
AbstractMap.containsKey(Object)

getEntry

public SafeHashMap.Entry getEntry(Object oKey)
Deprecated. 
Locate an Entry in the hash map based on its key.
Overrides:
getEntry in class SafeHashMap
Parameters:
oKey - the key object to search for
Returns:
the Entry or null

getCacheEntry

public ConfigurableCacheMap.Entry getCacheEntry(Object oKey)
Deprecated. 
Locate a cache Entry in the cache based on its key.
Specified by:
getCacheEntry in interface ConfigurableCacheMap
Parameters:
oKey - the key object to search for
Returns:
the Entry or null

put

public Object put(Object oKey,
                  Object oValue)
Deprecated. 
Store a value in the cache.
Specified by:
put in interface CacheMap
Specified by:
put in interface Map
Overrides:
put in class SafeHashMap
Parameters:
oKey - the key with which to associate the cache value
oValue - the value to cache
Returns:
the value that was cached associated with that key, or null if no value was cached associated with that key

put

public Object put(Object oKey,
                  Object oValue,
                  long cMillis)
Deprecated. 
Store a value in the cache that will be automatically evicted according to the specified expiration value.
Specified by:
put in interface CacheMap
Parameters:
oKey - the key with which to associate the cache value
oValue - the value to cache
cMillis - the number of milliseconds until the entry will expire; pass zero to use the cache's default ExpiryDelay settings; pass -1 to indicate that the entry should never expire
Returns:
the value that was cached associated with that key, or null if no value was cached associated with that key
Since:
Coherence 2.3

remove

public Object remove(Object oKey)
Deprecated. 
Remove an entry from the cache.
Specified by:
remove in interface Map
Overrides:
remove in class SafeHashMap
Parameters:
oKey - the key of a cached value
Returns:
the value that was cached associated with that key, or null if no value was cached associated with that key

clear

public void clear()
Deprecated. 
Remove everything from the cache.
Specified by:
clear in interface Map
Overrides:
clear in class SafeHashMap

addMapListener

public void addMapListener(MapListener listener)
Deprecated. 
Add a standard map listener that will receive all events (inserts, updates, deletes) that occur against the map, with the key, old-value and new-value included. This has the same result as the following call:
   addMapListener(listener, (Filter) null, false);
 
Specified by:
addMapListener in interface ObservableMap
Parameters:
listener - the MapEvent listener to add

removeMapListener

public void removeMapListener(MapListener listener)
Deprecated. 
Remove a standard map listener that previously signed up for all events. This has the same result as the following call:
   removeMapListener(listener, (Filter) null);
 
Specified by:
removeMapListener in interface ObservableMap
Parameters:
listener - the listener to remove

addMapListener

public void addMapListener(MapListener listener,
                           Object oKey,
                           boolean fLite)
Deprecated. 
Add a map listener for a specific key.

The listeners will receive MapEvent objects, but if fLite is passed as true, they might not contain the OldValue and NewValue properties.

To unregister the MapListener, use the ObservableMap.removeMapListener(MapListener, Object) method.

Specified by:
addMapListener in interface ObservableMap
Parameters:
listener - the MapEvent listener to add
oKey - the key that identifies the entry for which to raise events
fLite - true to indicate that the MapEvent objects do not have to include the OldValue and NewValue property values in order to allow optimizations

removeMapListener

public void removeMapListener(MapListener listener,
                              Object oKey)
Deprecated. 
Remove a map listener that previously signed up for events about a specific key.
Specified by:
removeMapListener in interface ObservableMap
Parameters:
listener - the listener to remove
oKey - the key that identifies the entry for which to raise events

addMapListener

public void addMapListener(MapListener listener,
                           Filter filter,
                           boolean fLite)
Deprecated. 
Add a map listener that receives events based on a filter evaluation.

The listeners will receive MapEvent objects, but if fLite is passed as true, they might not contain the OldValue and NewValue properties.

To unregister the MapListener, use the ObservableMap.removeMapListener(MapListener, Filter) method.

Specified by:
addMapListener in interface ObservableMap
Parameters:
listener - the MapEvent listener to add
filter - a filter that will be passed MapEvent objects to select from; a MapEvent will be delivered to the listener only if the filter evaluates to true for that MapEvent (see MapEventFilter); null is equivalent to a filter that alway returns true
fLite - true to indicate that the MapEvent objects do not have to include the OldValue and NewValue property values in order to allow optimizations

removeMapListener

public void removeMapListener(MapListener listener,
                              Filter filter)
Deprecated. 
Remove a map listener that previously signed up for events based on a filter evaluation.
Specified by:
removeMapListener in interface ObservableMap
Parameters:
listener - the listener to remove
filter - the filter that was passed into the corresponding addMapListener() call

getAll

public Map getAll(Collection colKeys)
Deprecated. 
Get all the specified keys, if they are in the cache. For each key that is in the cache, that key and its corresponding value will be placed in the map that is returned by this method. The absence of a key in the returned map indicates that it was not in the cache, which may imply (for caches that can load behind the scenes) that the requested data could not be loaded. <p/> The result of this method is defined to be semantically the same as the following implementation, without regards to threading issues:
 Map map = new AnyMap(); // could be a HashMap (but does not have to)
 for (Iterator iter = colKeys.iterator(); iter.hasNext(); )
     {
     Object oKey = iter.next();
     Object oVal = get(oKey);
     if (oVal != null || containsKey(oKey))
         {
         map.put(oKey, oVal);
         }
     }
 return map;
 
Specified by:
getAll in interface CacheMap
Parameters:
colKeys - a collection of keys that may be in the named cache
Returns:
a Map of keys to values for the specified keys passed in colKeys

evict

public void evict(Object oKey)
Deprecated. 
Evict a specified key from the cache, as if it had expired from the cache. If the key is not in the cache, then the method has no effect.
Specified by:
evict in interface ConfigurableCacheMap
Parameters:
oKey - the key to evict from the cache

evictAll

public void evictAll(Collection colKeys)
Deprecated. 
Evict the specified keys from the cache, as if they had each expired from the cache.

The result of this method is defined to be semantically the same as the following implementation: for (Iterator iter = colKeys.iterator(); iter.hasNext(); ) { Object oKey = iter.next(); evict(oKey); }

Specified by:
evictAll in interface ConfigurableCacheMap
Parameters:
colKeys - a collection of keys to evict from the cache

evict

public void evict()
Deprecated. 
Evict all entries from the cache that are no longer valid, and potentially prune the cache size if the cache is size-limited and its size is above the caching low water mark.
Specified by:
evict in interface ConfigurableCacheMap

getCacheStatistics

public CacheStatistics getCacheStatistics()
Deprecated. 
Returns the CacheStatistics for this cache.
Returns:
a CacheStatistics object

instantiateEntrySet

protected SafeHashMap.EntrySet instantiateEntrySet()
Deprecated. 
Factory pattern.
Overrides:
instantiateEntrySet in class SafeHashMap
Returns:
a new instance of the EntrySet class (or a subclass thereof)

instantiateKeySet

protected SafeHashMap.KeySet instantiateKeySet()
Deprecated. 
Factory pattern.
Overrides:
instantiateKeySet in class SafeHashMap
Returns:
a new instance of the KeySet class (or subclass thereof)

instantiateValuesCollection

protected SafeHashMap.ValuesCollection instantiateValuesCollection()
Deprecated. 
Factory pattern.
Overrides:
instantiateValuesCollection in class SafeHashMap
Returns:
a new instance of the ValuesCollection class (or subclass thereof)

toString

public String toString()
Deprecated. 
For debugging purposes, format the contents of the cache as a String.
Overrides:
toString in class AbstractMap
Returns:
a String representation of the cache contents

getUnits

public int getUnits()
Deprecated. 
Determine the number of units that the cache currently stores. <p/> Note: It is expected that the return type will be widened to a long in Coherence 4.
Specified by:
getUnits in interface ConfigurableCacheMap
Returns:
the current size of the cache in units

getHighUnits

public int getHighUnits()
Deprecated. 
Determine the limit of the cache size in units. The cache will prune itself automatically once it reaches its maximum unit level. This is often referred to as the "high water mark" of the cache. <p/> Note: It is expected that the return type will be widened to a long in Coherence 4.
Specified by:
getHighUnits in interface ConfigurableCacheMap
Returns:
the limit of the cache size in units

setHighUnits

public void setHighUnits(int cMax)
Deprecated. 
Update the maximum size of the cache in units. This is often referred to as the "high water mark" of the cache. <p/> Note: It is expected that the parameter will be widened to a long in Coherence 4.
Specified by:
setHighUnits in interface ConfigurableCacheMap
Parameters:
cMax - the new maximum size of the cache, in units

getLowUnits

public int getLowUnits()
Deprecated. 
Determine the point to which the cache will shrink when it prunes. This is often referred to as a "low water mark" of the cache. If the cache incrementally prunes, then this setting will have no effect. <p/> Note: It is expected that the parameter will be widened to a long in Coherence 4.
Specified by:
getLowUnits in interface ConfigurableCacheMap
Returns:
the number of units that the cache prunes to

setLowUnits

public void setLowUnits(int cMin)
Deprecated. 
Specify the point to which the cache will shrink when it prunes. This is often referred to as a "low water mark" of the cache. <p/> Note: It is expected that the parameter will be widened to a long in Coherence 4.
Specified by:
setLowUnits in interface ConfigurableCacheMap
Parameters:
cMin - the number of units that the cache prunes to

getUnitFactor

public int getUnitFactor()
Deprecated. 
Determine the factor by which the Units, LowUnits and HighUnits properties are adjusted. Using a binary unit calculator, for example, the factor 1048576 could be used to count megabytes instead of bytes. <p/> Note: This property exists only to avoid changing the type of the units, low units and high units properties from 32-bit values to 64-bit values. It is expected that the parameter will be dropped in Coherence 4.
Specified by:
getUnitFactor in interface ConfigurableCacheMap
Returns:
the units factor; the default is 1

setUnitFactor

public void setUnitFactor(int nFactor)
Deprecated. 
Determine the factor by which the Units, LowUnits and HighUnits properties are adjusted. Using a binary unit calculator, for example, the factor 1048576 could be used to count megabytes instead of bytes. <p/> Note: This property exists only to avoid changing the type of the units, low units and high units properties from 32-bit values to 64-bit values. It is expected that the parameter will be dropped in Coherence 4.
Specified by:
setUnitFactor in interface ConfigurableCacheMap
Parameters:
nFactor - the units factor; the default is 1

toInternalUnits

protected static long toInternalUnits(int cUnits,
                                      int nFactor)
Deprecated. 
Convert from an internal 64-bit unit value to an external 32-bit unit value using the configured units factor.
Parameters:
cUnits - an external 32-bit units value
Returns:
an internal 64-bit units value

toExternalUnits

protected static int toExternalUnits(long cUnits,
                                     int nFactor)
Deprecated. 
Convert from an internal 64-bit unit value to an external 32-bit unit value using the configured units factor.
Parameters:
cUnits - an internal 64-bit units value
nFactor - the unit factor
Returns:
an external 32-bit units value

getEvictionType

public int getEvictionType()
Deprecated. 
Determine the current eviction type.
Returns:
one of the EVICTION_POLICY_* enumerated values

setEvictionType

public void setEvictionType(int nType)
Deprecated. 
Specify the eviction type for the cache. The type can only be set to an external policy if an EvictionPolicy object has been provided.
Parameters:
nType - one of the EVICTION_POLICY_* enumerated values

getEvictionPolicy

public ConfigurableCacheMap.EvictionPolicy getEvictionPolicy()
Deprecated. 
Obtain the current EvictionPolicy used by the cache.
Specified by:
getEvictionPolicy in interface ConfigurableCacheMap
Returns:
the EvictionPolicy used by the cache

setEvictionPolicy

public void setEvictionPolicy(ConfigurableCacheMap.EvictionPolicy policy)
Deprecated. 
Set the EvictionPolicy for the cache to use.
Specified by:
setEvictionPolicy in interface ConfigurableCacheMap
Parameters:
policy - an EvictionPolicy

getUnitCalculatorType

public int getUnitCalculatorType()
Deprecated. 
Determine the current unit calculator type.
Returns:
one of the UNIT_CALCULATOR_* enumerated values

setUnitCalculatorType

public void setUnitCalculatorType(int nType)
Deprecated. 
Specify the unit calculator type for the cache. The type can only be set to an external unit calculator if a UnitCalculator object has been provided.
Parameters:
nType - one of the UNIT_CALCULATOR_* enumerated values

getUnitCalculator

public ConfigurableCacheMap.UnitCalculator getUnitCalculator()
Deprecated. 
Obtain the current UnitCalculator used by the cache.
Specified by:
getUnitCalculator in interface ConfigurableCacheMap
Returns:
the UnitCalculator used by the cache

setUnitCalculator

public void setUnitCalculator(ConfigurableCacheMap.UnitCalculator calculator)
Deprecated. 
Set the UnitCalculator for the cache to use.
Specified by:
setUnitCalculator in interface ConfigurableCacheMap
Parameters:
calculator - a UnitCalculator

getExpiryDelay

public int getExpiryDelay()
Deprecated. 
Determine the default "time to live" for each individual cache entry.
Specified by:
getExpiryDelay in interface ConfigurableCacheMap
Returns:
the number of milliseconds that a cache entry value will live, or zero if cache entries are never automatically expired

setExpiryDelay

public void setExpiryDelay(int cMillis)
Deprecated. 
Specify the default "time to live" for cache entries. This does not affect the already-scheduled expiry of existing entries.
Specified by:
setExpiryDelay in interface ConfigurableCacheMap
Parameters:
cMillis - the number of milliseconds that cache entries will live, or zero to disable automatic expiry

getFlushDelay

public int getFlushDelay()
Deprecated. 
Determine the delay between cache flushes. A cache flush evicts entries that have expired. <p/> This value is used by cache implementations that periodically evict entries that have expired; this value has no meaning for cache implementations that aggressively evict entries as they expire.
Specified by:
getFlushDelay in interface ConfigurableCacheMap
Returns:
the number of milliseconds between cache flushes, or zero which signifies that the cache never flushes

setFlushDelay

public void setFlushDelay(int cMillis)
Deprecated. 
Specify the delay between cache flushes. A cache flush evicts entries that have expired. <p/> This value is used by cache implementations that periodically evict entries that have expired; this value has no meaning for cache implementations that aggressively evict entries as they expire.
Specified by:
setFlushDelay in interface ConfigurableCacheMap
Parameters:
cMillis - the number of milliseconds between cache flushes, or zero to never flush

getFlushTime

public long getFlushTime()
Deprecated. as of Coherence 3.5
Determine the date/time at which the next cache flush is scheduled. Note that the date/time may be Long.MAX_VALUE, which implies that a flush will never occur. Also note that the cache may internally adjust the flush time to prevent a flush from occurring during certain processing as a means to raise concurrency.
Returns:
the date/time value, in milliseconds, when the cache will next automatically flush

setFlushTime

public void setFlushTime(long lMillis)
Deprecated. as of Coherence 3.5
Specify the date/time at which the next cache flush is to occur. Note that the date/time may be Long.MAX_VALUE, which implies that a flush will never occur. A time in the past or at the present will cause an immediate flush.
Parameters:
lMillis - the date/time value, in milliseconds, when the cache should next automatically flush

isIncrementalEviction

public boolean isIncrementalEviction()
Deprecated. 
Determine if incremental eviction is enabled. (Incremental eviction is not supported for custom eviction policies.)
Returns:
true if eviction is incremental; false if it is done in bulk
Since:
Coherence 3.5

setIncrementalEviction

public void setIncrementalEviction(boolean fIncrementalEvict)
Deprecated. 
Sepcify whether incremental eviction is enabled.
Parameters:
fIncrementalEvict - pass true toe enable incremental eviction; false to disable incremental eviction
Since:
Coherence 3.5

getCacheHits

public long getCacheHits()
Deprecated. 
Determine the rough number of cache hits since the cache statistics were last reset.
Returns:
the number of get(java.lang.Object) calls that have been served by existing cache entries

getCacheMisses

public long getCacheMisses()
Deprecated. 
Determine the rough number of cache misses since the cache statistics were last reset.
Returns:
the number of get(java.lang.Object) calls that failed to find an existing cache entry because the requested key was not in the cache

getHitProbability

public double getHitProbability()
Deprecated. 
Determine the rough probability (0 <= p <= 1) that any particular get(java.lang.Object) invocation will be satisfied by an existing entry in the cache, based on the statistics collected since the last reset of the cache statistics.
Returns:
the cache hit probability (0 <= p <= 1)

resetHitStatistics

public void resetHitStatistics()
Deprecated. 
Reset the cache statistics.

configureEviction

protected void configureEviction(int nType,
                                 ConfigurableCacheMap.EvictionPolicy policy)
Deprecated. 
Configure the eviction type and policy.
Parameters:
nType - one of the EVICTION_POLICY_* enumerated values
policy - an external eviction policy, or null

configureUnitCalculator

protected void configureUnitCalculator(int nType,
                                       ConfigurableCacheMap.UnitCalculator calculator)
Deprecated. 
Configure the unit calculator type and implementation.
Parameters:
nType - one of the UNIT_CALCULATOR_* enumerated values
calculator - an external unit calculator, or null

getEntryInternal

protected SafeHashMap.Entry getEntryInternal(Object oKey)
Deprecated. 
Locate an Entry in the hash map based on its key. If the Entry has expired, it is removed from the hash map. <p/> Unlike the getEntry(java.lang.Object) method, this method does not flush the cache (if necessary) or update cache statistics.
Overrides:
getEntryInternal in class SafeHashMap
Parameters:
oKey - the key object to search for
Returns:
the Entry or null if the entry is not found in the hash map or has expired

removeExpired

protected void removeExpired(OldCache.Entry entry,
                             boolean fRemoveInternal)
Deprecated. 
Remove an entry because it has expired.
Parameters:
entry - the expired cache entry
fRemoveInternal - true if the cache entry still needs to be removed from the cache

adjustUnits

protected void adjustUnits(int cDelta)
Deprecated. 
Adjust current size.

checkSize

protected void checkSize()
Deprecated. 
Check if the cache is too big, and if it is prune it by discarding the lowest priority cache entries.

prune

protected void prune()
Deprecated. 
Prune the cache by discarding the lowest priority cache entries.

checkFlush

protected void checkFlush()
Deprecated. as of Coherence 3.5, use evict()
Check if any entries in the cache have expired, and evict them if they have.

instantiateMapEvent

protected MapEvent instantiateMapEvent(int nId,
                                       Object oKey,
                                       Object oValueOld,
                                       Object oValueNew)
Deprecated. 
Factory pattern: instantiate a new MapEvent corresponding to the specified parameters.
Returns:
a new instance of the MapEvent class (or a subclass thereof)

getMapListenerSupport

protected MapListenerSupport getMapListenerSupport()
Deprecated. 
Accessor for the MapListenerSupport for sub-classes.
Returns:
the MapListenerSupport, or null if there are no listeners

hasListeners

protected boolean hasListeners()
Deprecated. 
Determine if the OverflowMap has any listeners at all.
Returns:
true iff this OverflowMap has at least one MapListener

dispatchEvent

protected void dispatchEvent(MapEvent evt)
Deprecated. 
Dispatch the passed event.
Parameters:
evt - a CacheEvent object

instantiateEntry

protected SafeHashMap.Entry instantiateEntry()
Deprecated. 
Factory method. This method exists to allow the OldCache class to be easily inherited from by allowing the Entry class to be easily sub-classed.
Overrides:
instantiateEntry in class SafeHashMap
Returns:
an instance of Entry that holds the passed cache value

Skip navigation links

Oracle® Coherence Java API Reference
Release 3.6.0.0

E15725-01


Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.