Package org.alfresco.repo.cache

Class DefaultSimpleCache<K extends Serializable,V>

java.lang.Object

org.alfresco.repo.cache.DefaultSimpleCache<K,V>

All Implemented Interfaces:

SimpleCache<K,V>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public final class DefaultSimpleCache<K extends Serializable,V>
extends Object
implements SimpleCache<K,V>, org.springframework.beans.factory.BeanNameAware

SimpleCache implementation backed by a Google Cache implementation.

Author:

Matt Ward

Constructor Summary

Constructors

Constructor	Description
DefaultSimpleCache()	Default constructor.
DefaultSimpleCache(int maxItems, boolean useMaxItems, int ttlSecs, int maxIdleSecs, String cacheName)	Construct a cache using the specified capacity and name.
DefaultSimpleCache(int maxItems, String cacheName)	Create a size limited, named cache with no other features enabled.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	contains(K key)
V	get(K key)
String	getCacheName()	Retrieve the name of this cache.
Collection<K>	getKeys()
int	getMaxIdleSecs()	Get the time-to-idle setting in seconds.
int	getMaxItems()	Gets the maximum number of items that the cache will hold.
int	getTTLSecs()	Get the time-to-live setting in seconds.
boolean	isUseMaxItems()	Is a size-cap in use?
void	put(K key, V value)
boolean	putAndCheckUpdate(K key, V value)	put method that may be used to check for updates in a thread-safe manner.
boolean	putAndCheckUpdate(K key, V value, boolean includeNewCheck)	put method that may be used to check for updates in a thread-safe manner.
void	remove(K key)
void	setBeanName(String cacheName)	Since there are many cache instances, it is useful to be able to associate a name with each one.
void	setCacheName(String cacheName)	Since there are many cache instances, it is useful to be able to associate a name with each one.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSimpleCache

public DefaultSimpleCache(int maxItems,
                          boolean useMaxItems,
                          int ttlSecs,
                          int maxIdleSecs,
                          String cacheName)

Construct a cache using the specified capacity and name.

Parameters:

maxItems - The cache capacity. 0 = use DEFAULT_CAPACITY

useMaxItems - Whether the maxItems value should be applied as a size-cap for the cache.

cacheName - An arbitrary cache name.

DefaultSimpleCache

public DefaultSimpleCache(int maxItems,
                          String cacheName)

Create a size limited, named cache with no other features enabled.

Parameters:

maxItems - int

cacheName - String

DefaultSimpleCache

public DefaultSimpleCache()

Default constructor. Initialises the cache with no size limit and no name.

Method Detail

contains

public boolean contains(K key)

Specified by:

contains in interface SimpleCache<K extends Serializable,V>

getKeys

public Collection<K> getKeys()

Specified by:

getKeys in interface SimpleCache<K extends Serializable,V>

get

public V get(K key)

Specified by:

get in interface SimpleCache<K extends Serializable,V>

put

public void put(K key,
                V value)

Specified by:

put in interface SimpleCache<K extends Serializable,V>

putAndCheckUpdate

public boolean putAndCheckUpdate(K key,
                                 V value)

put method that may be used to check for updates in a thread-safe manner.

Returns:

true if the put resulted in a change in value, false otherwise.

putAndCheckUpdate

public boolean putAndCheckUpdate(K key,
                                 V value,
                                 boolean includeNewCheck)

put method that may be used to check for updates in a thread-safe manner.

Parameters:

includeNewCheck - if true then we include the new value in the check

Returns:

true if the put resulted in a change in value, or if includeNewCheck is true and the put resulted in a new value, false otherwise.

remove

public void remove(K key)

Specified by:

remove in interface SimpleCache<K extends Serializable,V>

clear

public void clear()

Specified by:

clear in interface SimpleCache<K extends Serializable,V>

toString

public String toString()

Overrides:

toString in class Object

getMaxItems

public int getMaxItems()

Gets the maximum number of items that the cache will hold.

Returns:

maxItems

isUseMaxItems

public boolean isUseMaxItems()

Is a size-cap in use?

Returns:

useMaxItems

getTTLSecs

public int getTTLSecs()

Get the time-to-live setting in seconds.

Returns:

ttlSecs

getMaxIdleSecs

public int getMaxIdleSecs()

Get the time-to-idle setting in seconds.

Returns:

maxIdleSecs

getCacheName

public String getCacheName()

Retrieve the name of this cache.

Returns:

the cacheName

See Also:

setCacheName(String)

setCacheName

public void setCacheName(String cacheName)

Since there are many cache instances, it is useful to be able to associate a name with each one.

Parameters:

cacheName - String

See Also:

setBeanName(String)

setBeanName

public void setBeanName(String cacheName)

Since there are many cache instances, it is useful to be able to associate a name with each one.

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

Parameters:

cacheName - Set automatically by Spring, but can be set manually if required.