new utility for updated cached values in a multi-threaded environment.
[utils] / support / general / src / main / java / org / wamblee / cache / ForeverCache.java
1 /*
2  * Copyright 2005-2010 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not 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.
15  */ 
16 package org.wamblee.cache;
17
18 import java.io.Serializable;
19
20 import java.util.HashMap;
21
22 /**
23  * A very simple cache based on a HashMap, It never expires any entries, and has
24  * no bounds on its size.
25  * 
26  * @author Erik Brakkee
27  * 
28  */
29 public class ForeverCache<KeyType extends Serializable, ValueType extends Serializable>
30     implements Cache<KeyType, ValueType> {
31     /**
32      * Cached entries.
33      */
34     private HashMap<KeyType, ValueType> map;
35
36     /**
37      * Constructs the cache.
38      * 
39      */
40     public ForeverCache() {
41         map = new HashMap<KeyType, ValueType>();
42     }
43
44     /*
45      * (non-Javadoc)
46      * 
47      * @see org.wamblee.cache.Cache#put(KeyType, ValueType)
48      */
49     public synchronized void put(KeyType aKey, ValueType aValue) {
50         map.put(aKey, aValue);
51     }
52
53     /*
54      * (non-Javadoc)
55      * 
56      * @see org.wamblee.cache.Cache#get(KeyType)
57      */
58     public synchronized ValueType get(KeyType aKey) {
59         return map.get(aKey);
60     }
61
62     /*
63      * (non-Javadoc)
64      * 
65      * @see org.wamblee.cache.Cache#remove(KeyType)
66      */
67     public synchronized void remove(KeyType aKey) {
68         map.remove(aKey);
69     }
70
71     /*
72      * (non-Javadoc)
73      * 
74      * @see org.wamblee.cache.Cache#clear()
75      */
76     public synchronized void clear() {
77         map.clear();
78     }
79 }