KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jsmtpd > tools > cache > ICache


1 /*
2  *
3  * Jsmtpd, Java SMTP daemon
4  * Copyright (C) 2005 Jean-Francois POUX, jf.poux@laposte.net
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  *
20  */

21 package org.jsmtpd.tools.cache;
22
23 /**
24  * Cache things
25  * @author jean-francois POUX
26  *
27  * @param <Key>
28  * @param <Value>
29  */

30 public interface ICache <Key,Value>{
31     /**
32      * get something from cache
33      * @param k key
34      * @return
35      * @throws CacheFaultException when not found
36      */

37     public Value get (Key k);
38     /**
39      * Cache something
40      * @param key
41      * @param value
42      */

43     public void cache (Key key, Value value);
44     /**
45      * Clears the entire cache
46      *
47      */

48     public void clear();
49     /**
50      * Expires a cached item
51      * @param k
52      */

53     public void destroy (Key k);
54 }
55
Popular Tags