com.arsdigita.cms.dispatcher
Interface Cache

public interface Cache

An interface for caching objects.

Version:

$Revision: #5 $ $DateTime: 2004/04/07 16:07:11 $

Author:

Michael Pih (pihman@arsdigita.com)

Field Summary

static String

versionId

Method Summary

void	flush() Clears the cache.
Object	get(Object key) Lookup and fetch a cached object.
Object	put(Object key, Object value) Caches one object.
Object	remove(Object key) Removes one cached object.

Field Detail

versionId

public static final String versionId

See Also:

Constant Field Values

Method Detail

get

public Object get(Object key)

Lookup and fetch a cached object.

Parameters:

key - The object key

Returns:

The cached object, null if there is none

put

public Object put(Object key,
                  Object value)

Caches one object.

Parameters:

key - The object key

value - The object to be cached

Returns:

The cached object

remove

public Object remove(Object key)

Removes one cached object.

Parameters:

key - The object key

Returns:

The formerly-cached object

flush

public void flush()

Clears the cache.