net.oschina.j2cache.springcache

Class J2CacheSpringCacheAdapter

java.lang.Object

org.springframework.cache.support.AbstractValueAdaptingCache

net.oschina.j2cache.springcache.J2CacheSpringCacheAdapter

All Implemented Interfaces:

org.springframework.cache.Cache

public class J2CacheSpringCacheAdapter
extends org.springframework.cache.support.AbstractValueAdaptingCache

Author:

Chen

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.cache.Cache

org.springframework.cache.Cache.ValueRetrievalException, org.springframework.cache.Cache.ValueWrapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	J2CacheSpringCacheAdapter(boolean allowNullValues, CacheChannel j2Cache, String name) Create an AbstractValueAdaptingCache with the given setting.

Method Summary

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.
Object	getNativeCache() Return the underlying native cache provider.
protected Object	lookup(Object key)
void	put(Object key, Object value) Associate the specified value with the specified key in this cache.
org.springframework.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.

Methods inherited from class org.springframework.cache.support.AbstractValueAdaptingCache

fromStoreValue, get, get, isAllowNullValues, toStoreValue, toValueWrapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

J2CacheSpringCacheAdapter

protected J2CacheSpringCacheAdapter(boolean allowNullValues,
                                    CacheChannel j2Cache,
                                    String name)

Create an AbstractValueAdaptingCache with the given setting.

Parameters:

allowNullValues - whether to allow for null values

Method Detail

lookup

protected Object lookup(Object key)

Specified by:

lookup in class org.springframework.cache.support.AbstractValueAdaptingCache

getName

public String getName()

Return the cache name.

getNativeCache

public Object getNativeCache()

Return the underlying native cache provider.

get

public <T> T get(Object key,
                 Callable<T> valueLoader)
          throws org.springframework.cache.Cache.ValueRetrievalException

Return the value to which this cache maps the specified key, obtaining that value from 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 ValueRetrievalException

Parameters:

key - the key whose associated value is to be returned

valueLoader -

Returns:

the value to which this cache maps the specified key

Throws:

ValueRetrievalException - if the valueLoader throws an exception

org.springframework.cache.Cache.ValueRetrievalException

Since:

4.3

put

public void put(Object key,
                Object value)

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.

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

putIfAbsent

public org.springframework.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.

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.

Parameters:

key - the key with which the specified value is to be associated

value - 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 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.

Since:

4.1

evict

public void evict(Object key)

Evict the mapping for this key from this cache if it is present.

Parameters:

key - the key whose mapping is to be removed from the cache

clear

public void clear()

Remove all mappings from the cache.