← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to projects/projectapi/src/org/netbeans/modules/projectapi/TimedWeakReference.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
projects/projectapi/src/org/netbeans/modules/projectapi/TimedWeakReference.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.netbeans.modules.projectapi;
 
43
 
 
44
// XXX COPIED from org.openide.util w/ changes:
 
45
//     weak -> soft
 
46
//     timeout
 
47
//     removed map key functionality
 
48
 
 
49
import java.lang.ref.WeakReference;
 
50
import org.openide.util.RequestProcessor;
 
51
import org.openide.util.Utilities;
 
52
 
 
53
/**
 
54
 * A weak reference which is held strongly for a while after last access.
 
55
 * Lifecycle:
 
56
 * <ol>
 
57
 * <li>Created. Referent held strongly. A task is scheduled into the request
 
58
 *     processor for some time in the future (currently 15 seconds).</li>
 
59
 * <li>Expired. After the timeout, the reference switches to a normal weak
 
60
 *     reference.</li>
 
61
 * <li>Touched. If the value is accessed before it is garbage collected,
 
62
 *     whether the reference is expired or not, the reference is "touched".
 
63
 *     This means that the referent is again held strongly and the timeout
 
64
 *     is started from scratch.</li>
 
65
 * <li>Dead. If after expiry there is no access before the next full GC cycle,
 
66
 *     the GC algorithm may reclaim the reference. In this case the reference
 
67
 *     of course dies.</li>
 
68
 * </ol>
 
69
 * @author Jesse Glick
 
70
 */
 
71
public final class TimedWeakReference<T> extends WeakReference<T> implements Runnable {
 
72
    
 
73
    public static int TIMEOUT = 15000;
 
74
    
 
75
    private static final RequestProcessor RP = new RequestProcessor("TimedWeakReference"); // NOI18N
 
76
    
 
77
    private RequestProcessor.Task task;
 
78
    
 
79
    private T o;
 
80
    
 
81
    /** Time when the object was last time touched */
 
82
    private long touched;
 
83
    
 
84
    /**
 
85
     * Create a weak reference with timeout.
 
86
     * @param o the referent
 
87
     */
 
88
    public TimedWeakReference(T o) {
 
89
        super(o, Utilities.activeReferenceQueue());
 
90
        this.o = o;
 
91
        task = RP.create(this);
 
92
        task.schedule(TIMEOUT);
 
93
    }
 
94
    
 
95
    public synchronized void run() {
 
96
        if (o != null) {
 
97
            //System.err.println("Expire " + k);
 
98
            // how long we've really been idle
 
99
            long unused  = System.currentTimeMillis() - touched;
 
100
            if (unused > TIMEOUT / 2) {
 
101
                o = null;
 
102
                touched = 0;
 
103
            } else {
 
104
                task.schedule(TIMEOUT - (int) unused);
 
105
            }
 
106
        }
 
107
    }
 
108
    
 
109
    public synchronized T get() {
 
110
        if (o == null) {
 
111
            o = super.get();
 
112
        }
 
113
        if (o != null) {
 
114
            // touch me
 
115
            //System.err.println("Touch " + k);
 
116
            if (touched == 0) {
 
117
                task.schedule(TIMEOUT);
 
118
            } 
 
119
            touched = System.currentTimeMillis();
 
120
            return o;
 
121
        } else {
 
122
            return null;
 
123
        }
 
124
    }
 
125
    
 
126
}