org.nuxeo.ecm.core.cache

Class CacheAttributesChecker

java.lang.Object

org.nuxeo.ecm.core.cache.AbstractCache

org.nuxeo.ecm.core.cache.CacheAttributesChecker

All Implemented Interfaces:

Cache

public class CacheAttributesChecker
extends AbstractCache

Class to implement mandatory check attributes before calling implementation of cache This enable to have the same behavior for any use of cache for all implementation of cache

Since:

6.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Cache	cache

Fields inherited from class org.nuxeo.ecm.core.cache.AbstractCache

name, ttl

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CacheAttributesChecker(CacheDescriptor desc)

Method Summary

Modifier and Type	Method and Description
Serializable	get(String key) Get method to retrieve value from cache Must not raise exception if the key is null, but return null
Cache	getCache()
boolean	hasEntry(String key) Check if a given key is present inside the cache.
void	invalidate(String key) Invalidate the given key
void	invalidateAll() Invalidate all key-value stored in the cache
Set<String>	keySet() Returns the set of all keys stored in the cache.
void	put(String key, Serializable value) Put method to store a Serializable value

Methods inherited from class org.nuxeo.ecm.core.cache.AbstractCache

getName

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected Cache cache

Constructor Detail

CacheAttributesChecker

protected CacheAttributesChecker(CacheDescriptor desc)

Method Detail

getCache

public Cache getCache()

get

public Serializable get(String key)

Description copied from interface: Cache

Get method to retrieve value from cache Must not raise exception if the key is null, but return null

Parameters:

key - the string key

Returns:

the Serializable value, return null if the key does not exist or if the key is null

keySet

public Set<String> keySet()

Description copied from interface: Cache

Returns the set of all keys stored in the cache.

Returns:

the Set of all keys

invalidate

public void invalidate(String key)

Description copied from interface: Cache

Invalidate the given key

invalidateAll

public void invalidateAll()

Description copied from interface: Cache

Invalidate all key-value stored in the cache

put

public void put(String key,
                Serializable value)

Description copied from interface: Cache

Put method to store a Serializable value

Parameters:

key - the string key, if null, the value will not be stored

value - the value to store, if null, the value will not be stored

hasEntry

public boolean hasEntry(String key)

Description copied from interface: Cache

Check if a given key is present inside the cache. Compared to the get() method, this method must not update internal cache state and change TTL

Specified by:

hasEntry in interface Cache

Overrides:

hasEntry in class AbstractCache

Parameters:

key - the string key

Returns:

true if a corresponding entry exists, false otherwise