1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.jetspeed.cache.general;
18
19 /***
20 * <p>
21 * GeneralCache
22 * </p>
23 * <p>
24 * A very general, re-useable interface to wrap or create different caching implementations.
25 * </p>
26 * @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
27 * @version $Id: GeneralCache.java 516448 2007-03-09 16:25:47Z ate $
28 *
29 */
30 public interface GeneralCache
31 {
32
33 /***
34 *
35 * <p>
36 * get
37 * </p>
38 *
39 * @param key
40 * @return
41 */
42 Object get(String key);
43
44 /***
45 *
46 * <p>
47 * put
48 * </p>
49 *
50 * @param key
51 * @param value
52 */
53 void put(String key, Object value);
54
55 /***
56 *
57 * <p>
58 * contains
59 * </p>
60 *
61 * @param key
62 * @return
63 */
64 boolean contains(String key);
65
66 /***
67 *
68 * <p>
69 * remove
70 * </p>
71 *
72 * @param key
73 * @return
74 */
75 Object remove(String key);
76
77
78
79 }