01: /*
02: * CoadunationLib: The coaduntion implementation library.
03: * Copyright (C) 2006 Rift IT Contracting
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library; if not, write to the Free Software
17: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18: *
19: * Cache.java
20: *
21: * The cache interface supplies a standard set of cache maintainance methods. It
22: * does not enable a user to access the cache entries directly.
23: */
24:
25: package com.rift.coad.lib.cache;
26:
27: /**
28: * The cache interface supplies a standard set of cache maintainance methods. It
29: * does not enable a user to access the cache entries directly.
30: *
31: * @author Brett Chaldecott
32: */
33: public interface Cache {
34: /**
35: * This method is called to perform garbage collection on the cache entries.
36: */
37: public void garbageCollect();
38:
39: /**
40: * This method is called to forcibly remove everything from the cache.
41: */
42: public void clear();
43:
44: /**
45: * This mehtod returns true if the cache contains the checked entry.
46: *
47: * @return TRUE if the cache contains the checked entry.
48: * @param cacheEntry The entry to perform the check for.
49: */
50: public boolean contains(Object cacheEntry);
51: }
|