org.alfresco.repo.cache

Class DefaultSimpleCache

java.lang.Object

org.alfresco.repo.cache.DefaultSimpleCache

All Implemented Interfaces:

org.alfresco.repo.cache.SimpleCache, org.springframework.beans.factory.BeanNameAware

public final class DefaultSimpleCache
extends java.lang.Object
implements org.alfresco.repo.cache.SimpleCache, org.springframework.beans.factory.BeanNameAware

SimpleCache implementation backed by a ConcurrentLinkedHashMap.

Constructor Summary

Constructors

Constructor and Description
DefaultSimpleCache() Default constructor.
DefaultSimpleCache(int maxItems, java.lang.String cacheName) Construct a cache using the specified capacity and name.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	contains(java.io.Serializable key)
java.lang.Object	get(java.io.Serializable key)
java.lang.String	getCacheName() Retrieve the name of this cache.
java.util.Collection	getKeys()
int	getMaxItems() Gets the maximum number of items that the cache will hold.
void	put(java.io.Serializable key, java.lang.Object value)
boolean	putAndCheckUpdate(java.io.Serializable key, java.lang.Object value) put method that may be used to check for updates in a thread-safe manner.
void	remove(java.io.Serializable key)
void	setBeanName(java.lang.String cacheName) Since there are many cache instances, it is useful to be able to associate a name with each one.
void	setCacheName(java.lang.String cacheName) Since there are many cache instances, it is useful to be able to associate a name with each one.
void	setMaxItems(int maxItems) Sets the maximum number of items that the cache will hold.
java.lang.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,
                  java.lang.String cacheName)

Construct a cache using the specified capacity and name.

Parameters:

maxItems - The cache capacity.

DefaultSimpleCache

public DefaultSimpleCache()

Default constructor. Initialises the cache with a default capacity DefaultSimpleCache.DEFAULT_CAPACITY and no name.

Method Detail

contains

public boolean contains(java.io.Serializable key)

Specified by:

contains in interface org.alfresco.repo.cache.SimpleCache

getKeys

public java.util.Collection getKeys()

Specified by:

getKeys in interface org.alfresco.repo.cache.SimpleCache

get

public java.lang.Object get(java.io.Serializable key)

Specified by:

get in interface org.alfresco.repo.cache.SimpleCache

put

public void put(java.io.Serializable key,
       java.lang.Object value)

Specified by:

put in interface org.alfresco.repo.cache.SimpleCache

putAndCheckUpdate

public boolean putAndCheckUpdate(java.io.Serializable key,
                        java.lang.Object 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.

remove

public void remove(java.io.Serializable key)

Specified by:

remove in interface org.alfresco.repo.cache.SimpleCache

clear

public void clear()

Specified by:

clear in interface org.alfresco.repo.cache.SimpleCache

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setMaxItems

public void setMaxItems(int maxItems)

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

Parameters:

maxItems -

getMaxItems

public int getMaxItems()

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

Returns:

maxItems

getCacheName

public java.lang.String getCacheName()

Retrieve the name of this cache.

Returns:

the cacheName

See Also:

DefaultSimpleCache.setCacheName(String)

setCacheName

public void setCacheName(java.lang.String cacheName)

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

Parameters:

cacheName -

See Also:

DefaultSimpleCache.setBeanName(String)

setBeanName

public void setBeanName(java.lang.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.