summaryrefslogtreecommitdiff
path: root/src/main/java/com/c2kernel/utils/WeakCache.java
blob: 899852ef9fc84f6cf5ba9442ec90c49f33a1a86e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
package com.c2kernel.utils;

import java.lang.ref.ReferenceQueue;
import java.lang.ref.WeakReference;
import java.util.AbstractMap;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;

/*******************************************************************************
 * WeakReferences are reaped if no strong references are left next time the gc has a chance. 
 * The ClusterStorageManager caches can optionally use this one, for high volume imports etc
 *
 * $Revision: 1.5 $ $Date: 2004/10/29 13:29:09 $
 ******************************************************************************/
public class WeakCache<K, V> extends AbstractMap<K, V> {

    private final Map<K, WeakValue<V>> hash = new HashMap<K, WeakValue<V>>();
    private final int minSize;
    private final LinkedList<V> hardCache = new LinkedList<V>();
    private final ReferenceQueue<V> queue = new ReferenceQueue<V>();

    public WeakCache() {
        this(0);
    }

    public WeakCache(int minSize) {
        this.minSize = minSize;
    }

    /* (non-Javadoc)
	 * @see com.c2kernel.utils.NonStrongRefCache#get(java.lang.Object)
	 */
	@Override
    public V get(Object key) {
        V result = null;
        WeakValue<V> weak_ref = hash.get(key);
        if (weak_ref != null) {
            result = weak_ref.get();
            if (result == null)
                hash.remove(key);
            else
                if (minSize > 0) { // add to hard cache so it's not reaped for a while
                    hardCache.addFirst(result);
                    if (hardCache.size() > minSize) // trim last one off
                        hardCache.removeLast();
                }
        }
        return result;
    }

    /* (non-Javadoc)
	 * @see com.c2kernel.utils.NonStrongRefCache#put(K, V)
	 */
	@Override
	public V put(K key, V value) {
        processQueue();
        if (minSize > 0) {
            hardCache.addFirst(value);
            if (hardCache.size() > minSize)
                hardCache.removeLast();
        }
        hash.put(key, new WeakValue<V>(key, value, queue));
        return value;
    }

    /* (non-Javadoc)
	 * @see com.c2kernel.utils.NonStrongRefCache#remove(java.lang.Object)
	 */
	@Override
	public V remove(Object key) {
        processQueue();
        if (hash.containsKey(key)) return hash.remove(key).get();
        return null;
    }

    /* (non-Javadoc)
	 * @see com.c2kernel.utils.NonStrongRefCache#clear()
	 */
	@Override
	public void clear() {
        hardCache.clear();
        while(queue.poll()!=null);
        hash.clear();
    }

    /* (non-Javadoc)
	 * @see com.c2kernel.utils.NonStrongRefCache#size()
	 */
    @Override
	public int size() {
        processQueue();
        return hash.size();
    }

    /* (non-Javadoc)
	 * @see com.c2kernel.utils.NonStrongRefCache#keySet()
	 */
    @Override
	public Set<K> keySet() {
        processQueue();
        return hash.keySet();
    }

    /* (non-Javadoc)
	 * @see com.c2kernel.utils.NonStrongRefCache#entrySet()
	 */
    @Override
	public Set<Map.Entry<K, V>> entrySet() {
        // Would have to create another Map to do this - too expensive
        // Throwing runtime expensive is dangerous, but better than nulls
        throw new UnsupportedOperationException();
    }

    private static class WeakValue<V> extends WeakReference<V> {
        private final Object key;
        private WeakValue(Object key, V value, ReferenceQueue<V> q) {
            super(value, q);
            this.key = key;
        }
    }

    /**
     * Look for values that have been reaped, and remove their keys from the cache
     */
    private void processQueue() {
    	WeakValue<V> sv;
        while ((sv = (WeakValue<V>) queue.poll()) != null) {
            hash.remove(sv.key);
        }
    }

}