public class JCacheCache extends AbstractValueAdaptingCache
Cache
implementation on top of a
Cache
instance.
Note: This class has been updated for JCache 1.0, as of Spring 4.0.
Cache.ValueRetrievalException, Cache.ValueWrapper
Constructor and Description |
---|
JCacheCache(javax.cache.Cache<Object,Object> jcache)
Create an
JCacheCache instance. |
JCacheCache(javax.cache.Cache<Object,Object> jcache,
boolean allowNullValues)
Create an
JCacheCache instance. |
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.
|
<T> T |
get(Object key,
Callable<T> valueLoader)
Return the value to which this cache maps the specified key, obtaining
that value from
valueLoader if necessary. |
String |
getName()
Return the cache name.
|
javax.cache.Cache<Object,Object> |
getNativeCache()
Return 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 JCacheCache(javax.cache.Cache<Object,Object> jcache)
JCacheCache
instance.jcache
- backing JCache Cache instancepublic JCacheCache(javax.cache.Cache<Object,Object> jcache, boolean allowNullValues)
JCacheCache
instance.jcache
- backing JCache Cache instanceallowNullValues
- whether to accept and convert null values for this cachepublic final String getName()
Cache
public final javax.cache.Cache<Object,Object> getNativeCache()
Cache
@Nullable protected Object lookup(Object key)
AbstractValueAdaptingCache
lookup
in class AbstractValueAdaptingCache
key
- the key whose associated value is to be returnednull
if none@Nullable public <T> T get(Object key, Callable<T> valueLoader)
Cache
valueLoader
if necessary. This method provides
a simple substitute for the conventional "if cached, return; otherwise
create, cache and return" pattern.
If possible, implementations should ensure that the loading operation
is synchronized so that the specified valueLoader
is only called
once in case of concurrent access on the same key.
If the valueLoader
throws an exception, it is wrapped in
a Cache.ValueRetrievalException
key
- the key whose associated value is to be returnedpublic void put(Object key, @Nullable 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 key@Nullable public Cache.ValueWrapper putIfAbsent(Object key, @Nullable 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