public class ConcurrentMapCache extends AbstractValueAdaptingCache
Cache
implementation based on the
core JDK java.util.concurrent
package.
Useful for testing or simple caching scenarios, typically in combination
with SimpleCacheManager
or
dynamically through ConcurrentMapCacheManager
.
Note: As ConcurrentHashMap
(the default implementation used)
does not allow for null
values to be stored, this class will replace
them with a predefined internal object. This behavior can be changed through the
ConcurrentMapCache(String, ConcurrentMap, boolean)
constructor.
Cache.ValueWrapper
Constructor and Description |
---|
ConcurrentMapCache(String name)
Create a new ConcurrentMapCache with the specified name.
|
ConcurrentMapCache(String name,
boolean allowNullValues)
Create a new ConcurrentMapCache with the specified name.
|
ConcurrentMapCache(String name,
ConcurrentMap<Object,Object> store,
boolean allowNullValues)
Create a new ConcurrentMapCache with the specified name and the
given internal
ConcurrentMap to use. |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Remove all mappings from the cache.
|
void |
evict(Object key)
Evict the mapping for this key from this cache if it is present.
|
String |
getName()
Return the cache name.
|
ConcurrentMap<Object,Object> |
getNativeCache()
Return the the underlying native cache provider.
|
protected Object |
lookup(Object key)
Perform an actual lookup in the underlying store.
|
void |
put(Object key,
Object value)
Associate the specified value with the specified key in this cache.
|
Cache.ValueWrapper |
putIfAbsent(Object key,
Object value)
Atomically associate the specified value with the specified key in this cache
if it is not set already.
|
fromStoreValue, get, get, isAllowNullValues, toStoreValue, toValueWrapper
public ConcurrentMapCache(String name)
name
- the name of the cachepublic ConcurrentMapCache(String name, boolean allowNullValues)
name
- the name of the cacheallowNullValues
- whether to accept and convert null
values for this cachepublic ConcurrentMapCache(String name, ConcurrentMap<Object,Object> store, boolean allowNullValues)
ConcurrentMap
to use.name
- the name of the cachestore
- the ConcurrentMap to use as an internal storeallowNullValues
- whether to allow null
values
(adapting them to an internal null holder value)public final String getName()
Cache
public final ConcurrentMap<Object,Object> getNativeCache()
Cache
protected Object lookup(Object key)
AbstractValueAdaptingCache
lookup
in class AbstractValueAdaptingCache
key
- the key whose associated value is to be returnedpublic void put(Object key, Object value)
Cache
If the cache previously contained a mapping for this key, the old value is replaced by the specified value.
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified keypublic Cache.ValueWrapper putIfAbsent(Object key, Object value)
Cache
This is equivalent to:
Object existingValue = cache.get(key);
if (existingValue == null) {
cache.put(key, value);
return null;
} else {
return existingValue;
}
except that the action is performed atomically. While all out-of-the-box
CacheManager
implementations are able to perform the put atomically,
the operation may also be implemented in two steps, e.g. with a check for
presence and a subsequent put, in a non-atomic way. Check the documentation
of the native cache implementation that you are using for more details.key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified keynull
itself), or also null
if the cache did not contain any
mapping for that key prior to this call. Returning null
is therefore
an indicator that the given value
has been associated with the key.public void evict(Object key)
Cache
key
- the key whose mapping is to be removed from the cachepublic void clear()
Cache