summaryrefslogtreecommitdiff
path: root/src/main/java/org/cristalise/kernel/utils/TransientCache.java
blob: 4b13e0e40a7e2b984a2310877d3d5877cbe7fae1 (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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/**
 * This file is part of the CRISTAL-iSE kernel.
 * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * http://www.fsf.org/licensing/licenses/lgpl.html
 */
package org.cristalise.kernel.utils;
import java.lang.ref.Reference;
import java.util.AbstractMap;
import java.util.AbstractSet;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
/**************************************************************************
 * TransientCache - Uses transient references to allow unused entries to be
 * reaped by the java garbage collector.
 *
 * $Revision: 1.1 $
 * $Date: 2004/04/20 09:37:02 $
 *
 * Copyright (C) 2003 CERN - European Organization for Nuclear Research
 * All rights reserved.
 **************************************************************************/
public abstract class TransientCache<K, V> extends AbstractMap<K, V> {

    private Map<K, Reference<V>> map = new Hashtable<K, Reference<V>>();

    @Override
	public synchronized Set<Entry<K, V>> entrySet() {
        Map<K, V> newMap = new Hashtable<K,V>();
        Iterator<Entry<K, Reference<V>>> iter = map.entrySet().iterator();
        while (iter.hasNext()) {
        	Entry<K, Reference<V>> me = iter.next();
            Reference<V> ref = me.getValue();
            V o = ref.get();
            if (o == null) {
                // Delete cleared reference
                iter.remove();
            } else {
                // Copy out interior object
                newMap.put(me.getKey(), o);
            }
        }
        // Return set of interior objects
        return newMap.entrySet();
    }

    @Override
	public synchronized V put(K key, V value) {
        Reference<V> ref = makeReference(value);
        ref = map.put(key, ref);
        if (ref != null)
            return (ref.get());
        return null;
    }

    public abstract Reference<V> makeReference(Object value);

    @Override
	public V remove(Object key) {
        Iterator<Entry<K, Reference<V>>> i = map.entrySet().iterator();
        Entry<K, Reference<V>> correctEntry = null;
        if (key == null) {
            while (correctEntry == null && i.hasNext()) {
                Entry<K, Reference<V>> e = i.next();
                if (e.getKey() == null)
                    correctEntry = e;
            }
        } else {
            while (correctEntry == null && i.hasNext()) {
            	Entry<K, Reference<V>> e = i.next();
                if (key.equals(e.getKey()))
                    correctEntry = e;
            }
        }
        V oldValue = null;
        if (correctEntry != null) {
            Reference<V> correctReference = correctEntry.getValue();
            oldValue = correctReference.get();
            i.remove();
        }
        return oldValue;
    }
    /**
     *
     */
    @Override
	public void clear() {
        map.entrySet().clear();
    }

    private transient Set<K> keySet = null;

    @Override
	public Set<K> keySet() {
        if (keySet == null) {
            keySet = new AbstractSet<K>() {
            @Override
			public Iterator<K> iterator() {
                return new Iterator<K>() {
                private Iterator<Entry<K, Reference<V>>> i = map.entrySet().iterator();

                @Override
				public boolean hasNext() {
                    return i.hasNext();
                }

                @Override
				public K next() {
                    return i.next().getKey();
                }

                @Override
				public void remove() {
                    i.remove();
                }
                        };
            }

            @Override
			public int size() {
                return TransientCache.this.size();
            }

            @Override
			public boolean contains(Object k) {
                return TransientCache.this.containsKey(k);
            }
            };
        }
        return keySet;
        }

}