01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. The ASF licenses this file to You
04: * under the Apache License, Version 2.0 (the "License"); you may not
05: * use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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;
22: import java.util.Set;
23:
24: /**
25: * Base interface representing a cache in Roller.
26: */
27: public interface Cache {
28:
29: /**
30: * a unique identifier for the cache.
31: */
32: public String getId();
33:
34: /**
35: * put an item in the cache.
36: */
37: public void put(String key, Object value);
38:
39: /**
40: * get an item from the cache.
41: */
42: public Object get(String key);
43:
44: /**
45: * remove an item from the cache.
46: */
47: public void remove(String key);
48:
49: /**
50: * clear the entire cache.
51: */
52: public void clear();
53:
54: /**
55: * get cache stats.
56: */
57: public Map getStats();
58:
59: }
|