org.springframework.cache.guava

Class GuavaCache

java.lang.Object

org.springframework.cache.guava.GuavaCache

All Implemented Interfaces:

org.springframework.cache.Cache

public class GuavaCache
extends Object
implements org.springframework.cache.Cache

Spring Cache adapter implementation on top of a Guava Cache instance.

Requires Google Guava 12.0 or higher.

Since:

4.0

Author:

Juergen Hoeller, Stephane Nicoll

Nested Class Summary

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

org.springframework.cache.Cache.ValueWrapper

Constructor Summary

Constructors

Constructor and Description
GuavaCache(String name, com.google.common.cache.Cache<Object,Object> cache) Create a GuavaCache instance with the specified name and the given internal Cache to use.
GuavaCache(String name, com.google.common.cache.Cache<Object,Object> cache, boolean allowNullValues) Create a GuavaCache instance with the specified name and the given internal Cache to use.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	evict(Object key)
protected Object	fromStoreValue(Object storeValue) Convert the given value from the internal store to a user value returned from the get method (adapting null).
org.springframework.cache.Cache.ValueWrapper	get(Object key)
<T> T	get(Object key, Class<T> type)
String	getName()
com.google.common.cache.Cache<Object,Object>	getNativeCache()
boolean	isAllowNullValues()
void	put(Object key, Object value)
org.springframework.cache.Cache.ValueWrapper	putIfAbsent(Object key, Object value)
protected Object	toStoreValue(Object userValue) Convert the given user value, as passed into the put method, to a value in the internal store (adapting null).

Methods inherited from class java.lang.Object

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

Constructor Detail

GuavaCache

public GuavaCache(String name,
                  com.google.common.cache.Cache<Object,Object> cache)

Create a GuavaCache instance with the specified name and the given internal Cache to use.

Parameters:

name - the name of the cache

cache - the backing Guava Cache instance

GuavaCache

public GuavaCache(String name,
                  com.google.common.cache.Cache<Object,Object> cache,
                  boolean allowNullValues)

Create a GuavaCache instance with the specified name and the given internal Cache to use.

Parameters:

name - the name of the cache

cache - the backing Guava Cache instance

allowNullValues - whether to accept and convert null values for this cache

Method Detail

getName

public final String getName()

Specified by:

getName in interface org.springframework.cache.Cache

getNativeCache

public final com.google.common.cache.Cache<Object,Object> getNativeCache()

Specified by:

getNativeCache in interface org.springframework.cache.Cache

isAllowNullValues

public final boolean isAllowNullValues()

get

public org.springframework.cache.Cache.ValueWrapper get(Object key)

Specified by:

get in interface org.springframework.cache.Cache

get

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

Specified by:

get in interface org.springframework.cache.Cache

put

public void put(Object key,
                Object value)

Specified by:

put in interface org.springframework.cache.Cache

putIfAbsent

public org.springframework.cache.Cache.ValueWrapper putIfAbsent(Object key,
                                                                Object value)

Specified by:

putIfAbsent in interface org.springframework.cache.Cache

evict

public void evict(Object key)

Specified by:

evict in interface org.springframework.cache.Cache

clear

public void clear()

Specified by:

clear in interface org.springframework.cache.Cache

fromStoreValue

protected Object fromStoreValue(Object storeValue)

Convert the given value from the internal store to a user value returned from the get method (adapting null).

Parameters:

storeValue - the store value

Returns:

the value to return to the user

toStoreValue

protected Object toStoreValue(Object userValue)

Convert the given user value, as passed into the put method, to a value in the internal store (adapting null).

Parameters:

userValue - the given user value

Returns:

the value to store