01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/memory/tags/sakai_2-4-1/memory-api/api/src/java/org/sakaiproject/memory/api/Cacher.java $
03: * $Id: Cacher.java 7073 2006-03-27 20:56:40Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.memory.api;
21:
22: /**
23: * <p>
24: * Cacher is an interface for any object that uses memory caches.
25: * </p>
26: * <p>
27: * Cachers may be asked to clear their caches to free up memory or re-sync with external stores.
28: * </p>
29: */
30: public interface Cacher {
31: /**
32: * Clear out as much as possible anything cached; re-sync any cache that is needed to be kept.
33: */
34: void resetCache();
35:
36: /**
37: * Return the size of the cacher - indicating how much memory in use.
38: *
39: * @return The size of the cacher.
40: */
41: long getSize();
42:
43: /**
44: * Return a description of the cacher.
45: *
46: * @return The cacher's description.
47: */
48: String getDescription();
49: }
|