org.springframework.extensions.surf.cache

Class ModelObjectCache

java.lang.Object

org.springframework.extensions.surf.cache.ModelObjectCache

All Implemented Interfaces:

ContentCache<ModelObject>

public class ModelObjectCache
extends Object
implements ContentCache<ModelObject>

Cache for ModelObject instances. Based on an underlying ConcurrentHashMap implementation that is resposible for handling multi-threaded access to the cache.

The delay between checks against the underlying store is configurable.

Since:

1.1 Improved version using ConcurrentLinkedHashmap to discard old items.

Author:

kevinr, dward

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelObjectCache.ModelObjectSentinel Singleton sentinel class used to represent a 'null' value in some cache implementations

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,CacheItem<ModelObject>>	cache
protected long	delay
protected int	maxSize
protected org.springframework.extensions.webscripts.Store	store

Constructor Summary

Constructors

Constructor and Description
ModelObjectCache(org.springframework.extensions.webscripts.Store store, int maxSize, long delay) Instantiates a new model object cache.
ModelObjectCache(org.springframework.extensions.webscripts.Store store, long delay) Instantiates a new model object cache.

Method Summary

Methods

Modifier and Type	Method and Description
ModelObject	get(String key) Gets content stored in the cache
void	invalidate() Invalidates the cache
Set<String>	keys() Returns keys for the items in the cache
void	put(String key, ModelObject obj) Places content into the cache (with default timeout)
void	put(String key, ModelObject obj, long timeout) Places content into the cache
void	remove(String key) Removes a content object from the cache.
Collection<CacheItem<ModelObject>>	values() Returns the values for the items in the cache

Methods inherited from class java.lang.Object

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

Field Detail

store

protected final org.springframework.extensions.webscripts.Store store

delay

protected final long delay

maxSize

protected final int maxSize

cache

protected final Map<String,CacheItem<ModelObject>> cache

Constructor Detail

ModelObjectCache

public ModelObjectCache(org.springframework.extensions.webscripts.Store store,
                long delay)

Instantiates a new model object cache.

Parameters:

store - the store

delay - the delay to check modified dates for items in the cache

ModelObjectCache

public ModelObjectCache(org.springframework.extensions.webscripts.Store store,
                int maxSize,
                long delay)

Instantiates a new model object cache.

Parameters:

store - the store

maxSize - the maxSize

delay - the delay to check modified dates for items in the cache

Method Detail

get

public ModelObject get(String key)

Description copied from interface: ContentCache

Gets content stored in the cache

Specified by:

get in interface ContentCache<ModelObject>

Parameters:

key - the key

Returns:

the object

invalidate

public void invalidate()

Description copied from interface: ContentCache

Invalidates the cache

Specified by:

invalidate in interface ContentCache<ModelObject>

put

public void put(String key,
       ModelObject obj)

Description copied from interface: ContentCache

Places content into the cache (with default timeout)

Specified by:

put in interface ContentCache<ModelObject>

Parameters:

key - the key

obj - the obj

put

public void put(String key,
       ModelObject obj,
       long timeout)

Description copied from interface: ContentCache

Places content into the cache

Specified by:

put in interface ContentCache<ModelObject>

Parameters:

key - the key

obj - the obj

timeout - the timeout in milliseconds

remove

public void remove(String key)

Description copied from interface: ContentCache

Removes a content object from the cache.

Specified by:

remove in interface ContentCache<ModelObject>

Parameters:

key - the key

values

public Collection<CacheItem<ModelObject>> values()

Returns the values for the items in the cache

Returns:

the collection

keys

public Set<String> keys()

Returns keys for the items in the cache

Returns:

the set