org.exoplatform.services.cache
Interface ExoCache

All Known Implementing Classes:

AbstractExoCache, BaseExoCache, ConcurrentFIFOExoCache, FIFOExoCache, LFUExoCacheCreator.LFUExoCache, LRUExoCacheCreator.LRUExoCache, SimpleExoCache

public interface ExoCache

Created by The eXo Platform SAS. Author : Tuan Nguyen tuan08@users.sourceforge.net Date: Jun 14, 2003 Time: 1:12:22 PM

Method Summary

void	addCacheListener(CacheListener listener)
void	clearCache() Clears the cache.
Object	get(Serializable name) Performs a lookup operation.
List	getCachedObjects() Returns a list of cached object that are considered as valid when the method is called.
int	getCacheHit()
int	getCacheMiss()
int	getCacheSize()
String	getLabel()
long	getLiveTime()
int	getMaxSize()
String	getName()
boolean	isDistributed()
boolean	isLogEnabled()
boolean	isReplicated()
void	put(Serializable name, Object obj) Performs a put in the cache.
void	putMap(Map<Serializable,Object> objs) Performs a put of all the entries provided by the map argument.
Object	remove(Serializable name) Removes an entry from the cache.
List	removeCachedObjects() Clears the cache and returns the list of cached object that are considered as valid when the method is called.
void	select(CachedObjectSelector selector) Selects a subset of the cache.
void	setDistributed(boolean b)
void	setLabel(String s)
void	setLiveTime(long period)
void	setLogEnabled(boolean b)
void	setMaxSize(int max)
void	setName(String name)
void	setReplicated(boolean b)

Method Detail

getName

String getName()

setName

void setName(String name)

getLabel

String getLabel()

setLabel

void setLabel(String s)

get

Object get(Serializable name)
           throws Exception

Performs a lookup operation.

Parameters:

name - the cache key

Returns:

the cached value which may be evaluated to null

Throws:

Exception - any exception

remove

Object remove(Serializable name)
              throws Exception

Removes an entry from the cache.

Parameters:

name - the cache key

Returns:

the previously cached value or null if no entry existed or that entry value was evaluated to null

Throws:

Exception - any exception

put

void put(Serializable name,
         Object obj)
         throws Exception

Performs a put in the cache.

Parameters:

name - the cache key

obj - the cached value

Throws:

Exception - any exception

putMap

void putMap(Map<Serializable,Object> objs)
            throws Exception

Performs a put of all the entries provided by the map argument.

Parameters:

objs - the objects to put

Throws:

Exception - any exception

clearCache

void clearCache()
                throws Exception

Clears the cache.

Throws:

Exception - any exception

select

void select(CachedObjectSelector selector)
            throws Exception

Selects a subset of the cache.

Parameters:

selector - the selector

Throws:

Exception - any exception

getCacheSize

int getCacheSize()

getMaxSize

int getMaxSize()

setMaxSize

void setMaxSize(int max)

getLiveTime

long getLiveTime()

setLiveTime

void setLiveTime(long period)

getCacheHit

int getCacheHit()

getCacheMiss

int getCacheMiss()

getCachedObjects

List getCachedObjects()

Returns a list of cached object that are considered as valid when the method is called. Any non valid object will not be returnted.

Returns:

the list of cached objects

removeCachedObjects

List removeCachedObjects()
                         throws Exception

Clears the cache and returns the list of cached object that are considered as valid when the method is called. Any non valid object will not be returned.

Returns:

the list of cached objects

Throws:

Exception - any exception

addCacheListener

void addCacheListener(CacheListener listener)

isDistributed

boolean isDistributed()

setDistributed

void setDistributed(boolean b)

isReplicated

boolean isReplicated()

setReplicated

void setReplicated(boolean b)

isLogEnabled

boolean isLogEnabled()

setLogEnabled

void setLogEnabled(boolean b)