public class

EhCacheCache

extends Object
implements Cache<K, V>
java.lang.Object
   ↳ org.springframework.cache.ehcache.EhCacheCache

Class Overview

Cache implementation on top of an Ehcache instance.

Summary

Public Constructors
EhCacheCache(Ehcache ehcache)
Creates a EhCacheCache instance.
Public Methods
void clear()
Removes all mappings from the cache.
boolean containsKey(Object key)
Returns true if this cache contains a mapping for the specified key.
boolean containsValue(Object value)
Object get(Object key)
Returns the value to which this cache maps the specified key.
String getName()
Returns the cache name.
Ehcache getNativeCache()
Returns the the native, underlying cache provider.
Object put(Object key, Object value)
Object putIfAbsent(Object key, Object value)
Object remove(Object key)
Removes the mapping for this key from this cache if it is present (optional operation).
boolean remove(Object key, Object value)
Remove entry for key only if currently mapped to given value.
boolean replace(Object key, Object oldValue, Object newValue)
Object replace(Object key, Object value)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.cache.Cache

Public Constructors

public EhCacheCache (Ehcache ehcache)

Creates a EhCacheCache instance.

Parameters
ehcache backing Ehcache instance

Public Methods

public void clear ()

Removes all mappings from the cache.

public boolean containsKey (Object key)

Returns true if this cache contains a mapping for the specified key. More formally, returns true if and only if this cache contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

Parameters
key key whose presence in this cache is to be tested.
Returns
  • true if this cache contains a mapping for the specified key.

public boolean containsValue (Object value)

public Object 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. A return value of null does not necessarily indicate that the cache contains no mapping for the key; it's also possible that the cache explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

More formally, if this cache contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

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.

public String getName ()

Returns the cache name.

Returns
  • the cache name.

public Ehcache getNativeCache ()

Returns the the native, underlying cache provider.

public Object put (Object key, Object value)

public Object putIfAbsent (Object key, Object value)

public Object remove (Object key)

Removes the mapping for this key from this cache if it is present (optional operation). More formally, if this cache contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The cache can contain at most one such mapping.)

Returns the value to which the cache previously associated the key, or null if the cache contained no mapping for this key. (A null return can also indicate that the cache previously associated null with the specified key if the implementation supports null values.) The cache will not contain a mapping for the specified key once the call returns.

Parameters
key key whose mapping is to be removed from the cache.
Returns
  • previous value associated with specified key, or null if there was no mapping for key.

public boolean remove (Object key, Object value)

Remove entry for key only if currently mapped to given value. Similar to: 

   if ((cache.containsKey(key) && cache.get(key).equals(value)) {
      cache.remove(key);
      return true;
   } 
   else 
      return false;

Parameters
key key with which the specified value is associated.
value value associated with the specified key.
Returns
  • true if the value was removed, false otherwise

public boolean replace (Object key, Object oldValue, Object newValue)

public Object replace (Object key, Object value)