Class JCacheCache
- All Implemented Interfaces:
Cache
Cache
implementation on top of a
javax.cache.Cache
instance.
Note: This class has been updated for JCache 1.0, as of Spring 4.0.
- Since:
- 3.2
- Author:
- Juergen Hoeller, Stephane Nicoll
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.cache.Cache
Cache.ValueRetrievalException, Cache.ValueWrapper
-
Constructor Summary
ConstructorDescriptionJCacheCache
(javax.cache.Cache<Object, Object> jcache) Create aJCacheCache
instance.JCacheCache
(javax.cache.Cache<Object, Object> jcache, boolean allowNullValues) Create aJCacheCache
instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clear the cache through removing all mappings.void
Evict the mapping for this key from this cache if it is present.boolean
evictIfPresent
(Object key) Evict the mapping for this key from this cache if it is present, expecting the key to be immediately invisible for subsequent lookups.<T> T
Return the value to which this cache maps the specified key, obtaining that value fromvalueLoader
if necessary.final String
getName()
Return the cache name.Return the underlying native cache provider.boolean
Invalidate the cache through removing all mappings, expecting all entries to be immediately invisible for subsequent lookups.protected Object
Perform an actual lookup in the underlying store.void
Associate the specified value with the specified key in this cache.putIfAbsent
(Object key, Object value) Atomically associate the specified value with the specified key in this cache if it is not set already.Methods inherited from class org.springframework.cache.support.AbstractValueAdaptingCache
fromStoreValue, get, get, isAllowNullValues, toStoreValue, toValueWrapper
-
Constructor Details
-
JCacheCache
Create aJCacheCache
instance.- Parameters:
jcache
- backing JCache Cache instance
-
JCacheCache
Create aJCacheCache
instance.- Parameters:
jcache
- backing JCache Cache instanceallowNullValues
- whether to accept and convert null values for this cache
-
-
Method Details
-
getName
Description copied from interface:Cache
Return the cache name. -
getNativeCache
Description copied from interface:Cache
Return the underlying native cache provider. -
lookup
Description copied from class:AbstractValueAdaptingCache
Perform an actual lookup in the underlying store.- Specified by:
lookup
in classAbstractValueAdaptingCache
- Parameters:
key
- the key whose associated value is to be returned- Returns:
- the raw store value for the key, or
null
if none
-
get
Description copied from interface:Cache
Return the value to which this cache maps the specified key, obtaining that value fromvalueLoader
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 aCache.ValueRetrievalException
- Parameters:
key
- the key whose associated value is to be returned- Returns:
- the value to which this cache maps the specified key
- See Also:
-
put
Description copied from interface:Cache
Associate 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 by the specified value.
Actual registration may be performed in an asynchronous or deferred fashion, with subsequent lookups possibly not seeing the entry yet. This may for example be the case with transactional cache decorators. Use
Cache.putIfAbsent(java.lang.Object, java.lang.Object)
for guaranteed immediate registration.- Parameters:
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified key- See Also:
-
putIfAbsent
Description copied from interface:Cache
Atomically associate the specified value with the specified key in this cache if it is not set already.This is equivalent to:
except that the action is performed atomically. While all out-of-the-boxValueWrapper existingValue = cache.get(key); if (existingValue == null) { cache.put(key, value); } return existingValue;
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.The default implementation delegates to
Cache.get(Object)
andCache.put(Object, Object)
along the lines of the code snippet above.- Parameters:
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified key- Returns:
- the value to which this cache maps the specified key (which may be
null
itself), or alsonull
if the cache did not contain any mapping for that key prior to this call. Returningnull
is therefore an indicator that the givenvalue
has been associated with the key. - See Also:
-
evict
Description copied from interface:Cache
Evict the mapping for this key from this cache if it is present.Actual eviction may be performed in an asynchronous or deferred fashion, with subsequent lookups possibly still seeing the entry. This may for example be the case with transactional cache decorators. Use
Cache.evictIfPresent(java.lang.Object)
for guaranteed immediate removal.- Parameters:
key
- the key whose mapping is to be removed from the cache- See Also:
-
evictIfPresent
Description copied from interface:Cache
Evict the mapping for this key from this cache if it is present, expecting the key to be immediately invisible for subsequent lookups.The default implementation delegates to
Cache.evict(Object)
, returningfalse
for not-determined prior presence of the key. Cache providers and in particular cache decorators are encouraged to perform immediate eviction if possible (e.g. in case of generally deferred cache operations within a transaction) and to reliably determine prior presence of the given key.- Parameters:
key
- the key whose mapping is to be removed from the cache- Returns:
true
if the cache was known to have a mapping for this key before,false
if it did not (or if prior presence could not be determined)- See Also:
-
clear
public void clear()Description copied from interface:Cache
Clear the cache through removing all mappings.Actual clearing may be performed in an asynchronous or deferred fashion, with subsequent lookups possibly still seeing the entries. This may for example be the case with transactional cache decorators. Use
Cache.invalidate()
for guaranteed immediate removal of entries.- See Also:
-
invalidate
public boolean invalidate()Description copied from interface:Cache
Invalidate the cache through removing all mappings, expecting all entries to be immediately invisible for subsequent lookups.- Returns:
true
if the cache was known to have mappings before,false
if it did not (or if prior presence of entries could not be determined)- See Also:
-