KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > roller > util > cache > Cache


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. The ASF licenses this file to You
4  * under the Apache License, Version 2.0 (the "License"); you may not
5  * use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License. For additional information regarding
15  * copyright in this work, please see the NOTICE file in the top level
16  * directory of this distribution.
17  */

18
19 package org.apache.roller.util.cache;
20
21 import java.util.Map JavaDoc;
22 import java.util.Set JavaDoc;
23
24
25 /**
26  * Base interface representing a cache in Roller.
27  */

28 public interface Cache {
29     
30     /**
31      * a unique identifier for the cache.
32      */

33     public String JavaDoc getId();
34     
35     
36     /**
37      * put an item in the cache.
38      */

39     public void put(String JavaDoc key, Object JavaDoc value);
40     
41     
42     /**
43      * get an item from the cache.
44      */

45     public Object JavaDoc get(String JavaDoc key);
46     
47     
48     /**
49      * remove an item from the cache.
50      */

51     public void remove(String JavaDoc key);
52     
53     
54     /**
55      * clear the entire cache.
56      */

57     public void clear();
58     
59     
60     /**
61      * get cache stats.
62      */

63     public Map JavaDoc getStats();
64     
65 }
66
Popular Tags