Package org.springframework.data.couchbase.cache

Class CouchbaseCache

java.lang.Object

org.springframework.cache.support.AbstractValueAdaptingCache

org.springframework.data.couchbase.cache.CouchbaseCache

All Implemented Interfaces:

Cache

public class CouchbaseCache
extends AbstractValueAdaptingCache

Couchbase-backed Cache Methods that take a Class return non-wrapped objects - cache-miss cannot be distinguished from cached null - this is what AbstractValueAdaptingCache does Methods that do not take a Class return wrapped objects - the wrapper is null for cache-miss - the exception is T get(final Object key, final Callable<T> valueLoader), which does not return a wrapper because if there is a cache-miss, it gets the value from valueLoader (and caches it). There are anomalies with get(key, ValueLoader) - which returns non-wrapped object.

Nested Class Summary

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

Cache.ValueRetrievalException, Cache.ValueWrapper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CouchbaseCache(String name, CouchbaseCacheWriter cacheWriter, CouchbaseCacheConfiguration cacheConfig)

Method Summary

Modifier and Type	Method	Description
void	clear()
protected String	convertKey(Object key)	Convert key to a String representation used for cache key creation.
protected String	createCacheKey(Object key)	Customization hook for creating cache key before it gets serialized.
void	evict(Object key)
boolean	evictIfPresent(Object key)
<T> T	get(Object key, Class<T> type)
<T> T	get(Object key, Callable<T> valueLoader)
<T> T	get(Object key, Callable<T> valueLoader, Class<T> type)
CouchbaseCacheConfiguration	getCacheConfiguration()	Returns the configuration for this CouchbaseCache.
String	getName()
CouchbaseCacheWriter	getNativeCache()
boolean	invalidate()
protected Object	lookup(Object key)
protected Object	lookup(Object key, Class<?> clazz)	same as inherited, but passes clazz for transcoder
void	put(Object key, Object value)
Cache.ValueWrapper	putIfAbsent(Object key, Object value)
<T> T	putIfAbsent(Object key, Object value, Class<T> clazz)	Not sure why this isn't in AbstractValueAdaptingCache

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

fromStoreValue, get, isAllowNullValues, toStoreValue, toValueWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cache.Cache

retrieve, retrieve

Constructor Details

CouchbaseCache

protected CouchbaseCache(String name,
 CouchbaseCacheWriter cacheWriter,
 CouchbaseCacheConfiguration cacheConfig)

Method Details

getName

public String getName()

getNativeCache

public CouchbaseCacheWriter getNativeCache()

lookup

protected Object lookup(Object key,
 Class<?> clazz)

same as inherited, but passes clazz for transcoder

lookup

protected Object lookup(Object key)

Specified by:

lookup in class AbstractValueAdaptingCache

getCacheConfiguration

public CouchbaseCacheConfiguration getCacheConfiguration()

Returns the configuration for this CouchbaseCache.

get

public <T> T get(Object key,
 Callable<T> valueLoader)

get

public <T> T get(Object key,
 Class<T> type)

Specified by:

get in interface Cache

Overrides:

get in class AbstractValueAdaptingCache

get

public <T> T get(Object key,
 Callable<T> valueLoader,
 Class<T> type)

put

public void put(Object key,
 Object value)

putIfAbsent

public Cache.ValueWrapper putIfAbsent(Object key,
 Object value)

putIfAbsent

public <T> T putIfAbsent(Object key,
 Object value,
 Class<T> clazz)

Not sure why this isn't in AbstractValueAdaptingCache

Type Parameters:

T -

Parameters:

key -

value -

clazz -

Returns:

evict

public void evict(Object key)

evictIfPresent

public boolean evictIfPresent(Object key)

invalidate

public boolean invalidate()

clear

public void clear()

createCacheKey

protected String createCacheKey(Object key)

Customization hook for creating cache key before it gets serialized.

Parameters:

key - will never be null.

Returns:

never null.

convertKey

protected String convertKey(Object key)

Convert key to a String representation used for cache key creation.

Parameters:

key - will never be null.

Returns:

never null.

Throws:

IllegalStateException - if key cannot be converted to String.