org.springframework.cache
Interface Cache

All Known Implementing Classes:
ConcurrentMapCache, EhCacheCache

public interface Cache

Interface that defines the common cache operations. Note: Due to the generic use of caching, it is recommended that implementations allow storage of null values (for example to cache methods that return null).

Author:
Costin Leau

Nested Class Summary
static interface Cache.ValueWrapper
          A (wrapper) object representing a cache value.
 
Method Summary
 void clear()
          Removes all mappings from the cache.
 void evict(Object key)
          Evicts the mapping for this key from this cache if it is present.
 Cache.ValueWrapper get(Object key)
          Returns the value to which this cache maps the specified key.
 String getName()
          Returns the cache name.
 Object getNativeCache()
          Returns the the native, underlying cache provider.
 void put(Object key, Object value)
          Associates the specified value with the specified key in this cache.
 

Method Detail

getName

String getName()
Returns the cache name.

Returns:
the cache name.

getNativeCache

Object getNativeCache()
Returns the the native, underlying cache provider.

Returns:
the underlying native cache provider.

get

Cache.ValueWrapper get(Object key)
Returns the value to which this cache maps the specified key. Returns null if the cache contains no mapping for this key.

Parameters:
key - key whose associated value is to be returned.
Returns:
the value to which this cache maps the specified key, or null if the cache contains no mapping for this key.

put

void put(Object key,
         Object value)
Associates 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 - key with which the specified value is to be associated.
value - value to be associated with the specified key.

evict

void evict(Object key)
Evicts the mapping for this key from this cache if it is present.

Parameters:
key - key whose mapping is to be removed from the cache.

clear

void clear()
Removes all mappings from the cache.