类 JCacheCache
- java.lang.Object
- org.springframework.cache.support.AbstractValueAdaptingCache
- org.springframework.cache.jcache.JCacheCache
- 所有已实现的接口:
Cache
public class JCacheCache extends AbstractValueAdaptingCache
Cacheimplementation on top of ajavax.cache.Cacheinstance.Note: This class has been updated for JCache 1.0, as of Spring 4.0.
- 从以下版本开始:
- 3.2
- 作者:
- Juergen Hoeller, Stephane Nicoll
- 另请参阅:
JCacheCacheManager
嵌套类概要
从接口继承的嵌套类/接口 org.springframework.cache.Cache
Cache.ValueRetrievalException, Cache.ValueWrapper
构造器概要
构造器 构造器 说明 JCacheCache(javax.cache.Cache<Object,Object> jcache)Create aJCacheCacheinstance.JCacheCache(javax.cache.Cache<Object,Object> jcache, boolean allowNullValues)Create aJCacheCacheinstance.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 voidclear()Clear the cache through removing all mappings.voidevict(Object key)Evict the mapping for this key from this cache if it is present.booleanevictIfPresent(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> Tget(Object key, Callable<T> valueLoader)Return the value to which this cache maps the specified key, obtaining that value fromvalueLoaderif necessary.StringgetName()Return the cache name.javax.cache.Cache<Object,Object>getNativeCache()Return the underlying native cache provider.booleaninvalidate()Invalidate the cache through removing all mappings, expecting all entries to be immediately invisible for subsequent lookups.protected Objectlookup(Object key)Perform an actual lookup in the underlying store.voidput(Object key, Object value)Associate the specified value with the specified key in this cache.Cache.ValueWrapperputIfAbsent(Object key, Object value)Atomically associate the specified value with the specified key in this cache if it is not set already.从类继承的方法 org.springframework.cache.support.AbstractValueAdaptingCache
fromStoreValue, get, get, isAllowNullValues, toStoreValue, toValueWrapper
构造器详细资料
JCacheCache
public JCacheCache(javax.cache.Cache<Object,Object> jcache)
Create aJCacheCacheinstance.- 参数:
jcache- backing JCache Cache instance
JCacheCache
public JCacheCache(javax.cache.Cache<Object,Object> jcache, boolean allowNullValues)
Create aJCacheCacheinstance.- 参数:
jcache- backing JCache Cache instanceallowNullValues- whether to accept and convert null values for this cache
方法详细资料
getNativeCache
public final javax.cache.Cache<Object,Object> getNativeCache()
从接口复制的说明:CacheReturn the underlying native cache provider.
lookup
@Nullable protected Object lookup(Object key)
从类复制的说明:AbstractValueAdaptingCachePerform an actual lookup in the underlying store.- 指定者:
lookup在类中AbstractValueAdaptingCache- 参数:
key- the key whose associated value is to be returned- 返回:
- the raw store value for the key, or
nullif none
get
@Nullable public <T> T get(Object key, Callable<T> valueLoader)
从接口复制的说明:CacheReturn the value to which this cache maps the specified key, obtaining that value fromvalueLoaderif 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
valueLoaderis only called once in case of concurrent access on the same key.If the
valueLoaderthrows an exception, it is wrapped in aCache.ValueRetrievalException- 参数:
key- the key whose associated value is to be returned- 返回:
- the value to which this cache maps the specified key
- 另请参阅:
Cache.get(Object)
put
public void put(Object key, @Nullable Object value)
从接口复制的说明:CacheAssociate 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.- 参数:
key- the key with which the specified value is to be associatedvalue- the value to be associated with the specified key- 另请参阅:
Cache.putIfAbsent(Object, Object)
putIfAbsent
@Nullable public Cache.ValueWrapper putIfAbsent(Object key, @Nullable Object value)
从接口复制的说明:CacheAtomically 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;CacheManagerimplementations 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.- 参数:
key- the key with which the specified value is to be associatedvalue- the value to be associated with the specified key- 返回:
- the value to which this cache maps the specified key (which may be
nullitself), or alsonullif the cache did not contain any mapping for that key prior to this call. Returningnullis therefore an indicator that the givenvaluehas been associated with the key. - 另请参阅:
Cache.put(Object, Object)
evict
public void evict(Object key)
从接口复制的说明:CacheEvict 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.- 参数:
key- the key whose mapping is to be removed from the cache- 另请参阅:
Cache.evictIfPresent(Object)
evictIfPresent
public boolean evictIfPresent(Object key)
从接口复制的说明:CacheEvict 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), returningfalsefor 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.- 参数:
key- the key whose mapping is to be removed from the cache- 返回:
trueif the cache was known to have a mapping for this key before,falseif it did not (or if prior presence could not be determined)- 另请参阅:
Cache.evict(Object)
clear
public void clear()
从接口复制的说明:CacheClear 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.- 另请参阅:
Cache.invalidate()
invalidate
public boolean invalidate()
从接口复制的说明:CacheInvalidate the cache through removing all mappings, expecting all entries to be immediately invisible for subsequent lookups.- 返回:
trueif the cache was known to have mappings before,falseif it did not (or if prior presence of entries could not be determined)- 另请参阅:
Cache.clear()