Skip navigation links
com.tangosol.net.cache
Interface CacheMap
- All Superinterfaces:
- Map, ObservableMap
- All Known Subinterfaces:
- ConfigurableCacheMap, NamedCache, OptimisticNamedCache
- All Known Implementing Classes:
- BundlingNamedCache, ContinuousQueryCache, ConverterCollections.ConverterCacheMap, ConverterCollections.ConverterNamedCache, LocalCache, NearCache, ObservableSplittingBackingCache, ObservableSplittingBackingMap, OldCache, OverflowMap, ReadonlyNamedCache, ReadWriteBackingMap, ReadWriteSplittingBackingMap, SerializationCache, VersionedBackingMap, VersionedNearCache, WrapperNamedCache
-
public interface CacheMap
- extends ObservableMap
A CacheMap is a Map that supports caching. This interface will be eventually replaced by the javax.cache.Cache interface.
- Since:
- Coherence 2.3
- Author:
- gg 2004.01.05
Nested classes/interfaces inherited from interface java.util.Map |
Map.Entry |
Field Summary |
static long |
EXPIRY_DEFAULT
A special time-to-live value that can be passed to the extended put method to indicate that the cache's default expiry should be used. |
static long |
EXPIRY_NEVER
A special time-to-live value that can be passed to the extended put method to indicate that the cache entry should never expire. |
Method Summary |
Map |
getAll(Collection colKeys)
Get all the specified keys, if they are in the cache. |
Object |
put(Object oKey, Object oValue)
Associates the specified value with the specified key in this cache. |
Object |
put(Object oKey, Object oValue, long cMillis)
Associates the specified value with the specified key in this cache. |
Methods inherited from interface java.util.Map |
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, values |
EXPIRY_DEFAULT
static final long EXPIRY_DEFAULT
- A special time-to-live value that can be passed to the extended
put
method to indicate that the cache's default expiry should be used.
- See Also:
- Constant Field Values
EXPIRY_NEVER
static final long EXPIRY_NEVER
- A special time-to-live value that can be passed to the extended
put
method to indicate that the cache entry should never expire.
- See Also:
- Constant Field Values
getAll
Map getAll(Collection colKeys)
- 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;
-
- 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
- Since:
- Coherence 2.5
put
Object put(Object oKey,
Object oValue)
- Associates the specified value with the specified key in this cache. If the cache previously contained a mapping for this key, the old value is replaced. <p/> Invoking this method is equivalent to the following call:
put(oKey, oValue, EXPIRY_DEFAULT);
-
- Specified by:
put
in interface Map
-
- Parameters:
oKey
- key with which the specified value is to be associated
oValue
- value to be associated with the specified key
- Returns:
- previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values
put
Object put(Object oKey,
Object oValue,
long cMillis)
- Associates the specified value with the specified key in this cache. If the cache previously contained a mapping for this key, the old value is replaced. This variation of the
put(Object oKey, Object oValue)
method allows the caller to specify an expiry (or "time to live") for the cache entry.
-
- Parameters:
oKey
- key with which the specified value is to be associated
oValue
- value to be associated with the specified key
cMillis
- the number of milliseconds until the cache entry will expire, also referred to as the entry's "time to live"; pass EXPIRY_DEFAULT
to use the cache's default time-to-live setting; pass EXPIRY_NEVER
to indicate that the cache entry should never expire; this milliseconds value is not a date/time value, such as is returned from System.currentTimeMillis()
- Returns:
- previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values
- Throws:
UnsupportedOperationException
- if the requested expiry is a positive value and the implementation does not support expiry of cache entries
Skip navigation links
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.