org.sakaiproject.service.framework.memory
Interface Cacher

All Known Subinterfaces:
Cache, MultiRefCache, SiteCache
All Known Implementing Classes:
MemCache, MultiRefCacheImpl, NotificationCache, SiteCacheImpl

public interface Cacher

Cacher is an interface for any object that uses memory caches.

Cachers may be asked to clear their caches to free up memory or re-sync with external stores.

Version:
$Revision: 632 $
Author:
University of Michigan, Sakai Software Development Team

Method Summary
 String getDescription()
          Return a description of the cacher.
 long getSize()
          Return the size of the cacher - indicating how much memory in use.
 void resetCache()
          Clear out as much as possible anything cached; re-sync any cache that is needed to be kept.
 

Method Detail

resetCache

public void resetCache()
Clear out as much as possible anything cached; re-sync any cache that is needed to be kept.


getSize

public long getSize()
Return the size of the cacher - indicating how much memory in use.

Returns:
The size of the cacher.

getDescription

public String getDescription()
Return a description of the cacher.

Returns:
The cacher's description.