com.tangosol.util
Class ConverterCollections.ConverterCacheMap

java.lang.Object
  com.tangosol.util.Base
      com.tangosol.util.ConverterCollections.ConverterMap
          com.tangosol.util.ConverterCollections.ConverterObservableMap
              com.tangosol.util.ConverterCollections.ConverterCacheMap

All Implemented Interfaces:

CacheMap, ObservableMap, java.io.Serializable, java.util.Map

Direct Known Subclasses:

ConverterCollections.ConverterNamedCache

Enclosing class:

ConverterCollections

public static class ConverterCollections.ConverterCacheMap
extends ConverterCollections.ConverterObservableMap
implements CacheMap, java.io.Serializable

A Converter CacheMap views an underlying CacheMap through a set of key and value Converters.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry

Field Summary

Fields inherited from class com.tangosol.util.ConverterCollections.ConverterMap

m_convKeyDown, m_convKeyUp, m_convValDown, m_convValUp, m_map, m_set

Fields inherited from interface com.tangosol.net.cache.CacheMap

EXPIRY_DEFAULT, EXPIRY_NEVER

Constructor Summary

ConverterCollections.ConverterCacheMap(CacheMap map, Converter convKeyUp, Converter convKeyDown, Converter convValUp, Converter convValDown)
Constructor.

Method Summary

java.util.Map	getAll(java.util.Collection colKeys) Get all the specified keys, if they are in the cache.
CacheMap	getCacheMap() Return the underlying CacheMap.
java.lang.Object	put(java.lang.Object oKey, java.lang.Object oValue, long cMillis) Associates the specified value with the specified key in this cache.

Methods inherited from class com.tangosol.util.ConverterCollections.ConverterObservableMap

addMapListener, addMapListener, addMapListener, getConverterListener, getObservableMap, removeMapListener, removeMapListener, removeMapListener

Methods inherited from class com.tangosol.util.ConverterCollections.ConverterMap

clear, containsKey, containsValue, entrySet, get, getConverterKeyDown, getConverterKeyUp, getConverterValueDown, getConverterValueUp, getMap, instantiateCollection, instantiateEntrySet, instantiateMap, instantiateSet, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from interface com.tangosol.net.cache.CacheMap

put

Methods inherited from interface com.tangosol.util.ObservableMap

addMapListener, addMapListener, addMapListener, removeMapListener, removeMapListener, removeMapListener

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, values

Constructor Detail

ConverterCollections.ConverterCacheMap

public ConverterCollections.ConverterCacheMap(CacheMap map,
                                              Converter convKeyUp,
                                              Converter convKeyDown,
                                              Converter convValUp,
                                              Converter convValDown)

Constructor.

Parameters:

map - the underlying CacheMap

convKeyUp - the Converter to view the underlying CacheMap's keys through

convKeyDown - the Converter to use to pass keys down to the underlying CacheMap

convValUp - the Converter to view the underlying CacheMap's values through

convValDown - the Converter to use to pass values down to the underlying CacheMap

Method Detail

getAll

public java.util.Map getAll(java.util.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.

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

put

public java.lang.Object put(java.lang.Object oKey,
                            java.lang.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 CacheMap.put(Object oKey, Object oValue) method allows the caller to specify an expiry (or "time to live") for the cache entry.

Specified by:

put in interface CacheMap

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 CacheMap.EXPIRY_DEFAULT to use the cache's default time-to-live setting; pass CacheMap.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

getCacheMap

public CacheMap getCacheMap()

Return the underlying CacheMap.

Returns:

the underlying CacheMap