public class CaffeineCache extends AbstractValueAdaptingCache
Cache adapter implementation
on top of a Caffeine Cache instance.
Requires Caffeine 2.1 or higher.
Cache.ValueRetrievalException, Cache.ValueWrapper| Constructor and Description |
|---|
CaffeineCache(String name,
com.github.benmanes.caffeine.cache.Cache<Object,Object> cache)
Create a
CaffeineCache instance with the specified name and the
given internal Cache to use. |
CaffeineCache(String name,
com.github.benmanes.caffeine.cache.Cache<Object,Object> cache,
boolean allowNullValues)
Create a
CaffeineCache instance with the specified name and the
given internal Cache to use. |
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Clear the cache through removing all mappings.
|
void |
evict(Object key)
Evict the mapping for this key from this cache if it is present.
|
Cache.ValueWrapper |
get(Object key)
Return the value to which this cache maps the specified key.
|
<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.
|
com.github.benmanes.caffeine.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, isAllowNullValues, toStoreValue, toValueWrapperpublic CaffeineCache(String name, com.github.benmanes.caffeine.cache.Cache<Object,Object> cache)
CaffeineCache instance with the specified name and the
given internal Cache to use.name - the name of the cachecache - the backing Caffeine Cache instancepublic CaffeineCache(String name, com.github.benmanes.caffeine.cache.Cache<Object,Object> cache, boolean allowNullValues)
CaffeineCache instance with the specified name and the
given internal Cache to use.name - the name of the cachecache - the backing Caffeine Cache instanceallowNullValues - whether to accept and convert null
values for this cachepublic final String getName()
Cachepublic final com.github.benmanes.caffeine.cache.Cache<Object,Object> getNativeCache()
Cache@Nullable public Cache.ValueWrapper get(Object key)
CacheReturns null if the cache contains no mapping for this key;
otherwise, the cached value (which may be null itself) will
be returned in a Cache.ValueWrapper.
get in interface Cacheget in class AbstractValueAdaptingCachekey - the key whose associated value is to be returnedCache.ValueWrapper which may also hold
a cached null value. A straight null being
returned means that the cache contains no mapping for this key.Cache.get(Object, Class),
Cache.get(Object, Callable)@Nullable public <T> T get(Object key, Callable<T> valueLoader)
CachevalueLoader 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 returnedCache.get(Object)@Nullable protected Object lookup(Object key)
AbstractValueAdaptingCachelookup in class AbstractValueAdaptingCachekey - the key whose associated value is to be returnednull if nonepublic void put(Object key, @Nullable Object value)
CacheIf 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)
CacheThis is equivalent to:
ValueWrapper 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.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.Cache.put(Object, Object)public void evict(Object key)
Cachekey - the key whose mapping is to be removed from the cachepublic void clear()
Cache