rt/emul/compact/src/main/java/java/lang/ref/WeakReference.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Tue, 26 Feb 2013 16:54:16 +0100
changeset 772 d382dacfd73f
parent 601 emul/compact/src/main/java/java/lang/ref/WeakReference.java@5198affdb915
permissions -rw-r--r--
Moving modules around so the runtime is under one master pom and can be built without building other modules that are in the repository
jaroslav@601
     1
/*
jaroslav@601
     2
 * Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved.
jaroslav@601
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@601
     4
 *
jaroslav@601
     5
 * This code is free software; you can redistribute it and/or modify it
jaroslav@601
     6
 * under the terms of the GNU General Public License version 2 only, as
jaroslav@601
     7
 * published by the Free Software Foundation.  Oracle designates this
jaroslav@601
     8
 * particular file as subject to the "Classpath" exception as provided
jaroslav@601
     9
 * by Oracle in the LICENSE file that accompanied this code.
jaroslav@601
    10
 *
jaroslav@601
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@601
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@601
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@601
    14
 * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@601
    15
 * accompanied this code).
jaroslav@601
    16
 *
jaroslav@601
    17
 * You should have received a copy of the GNU General Public License version
jaroslav@601
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@601
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@601
    20
 *
jaroslav@601
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@601
    22
 * or visit www.oracle.com if you need additional information or have any
jaroslav@601
    23
 * questions.
jaroslav@601
    24
 */
jaroslav@601
    25
jaroslav@601
    26
package java.lang.ref;
jaroslav@601
    27
jaroslav@601
    28
jaroslav@601
    29
/**
jaroslav@601
    30
 * Weak reference objects, which do not prevent their referents from being
jaroslav@601
    31
 * made finalizable, finalized, and then reclaimed.  Weak references are most
jaroslav@601
    32
 * often used to implement canonicalizing mappings.
jaroslav@601
    33
 *
jaroslav@601
    34
 * <p> Suppose that the garbage collector determines at a certain point in time
jaroslav@601
    35
 * that an object is <a href="package-summary.html#reachability">weakly
jaroslav@601
    36
 * reachable</a>.  At that time it will atomically clear all weak references to
jaroslav@601
    37
 * that object and all weak references to any other weakly-reachable objects
jaroslav@601
    38
 * from which that object is reachable through a chain of strong and soft
jaroslav@601
    39
 * references.  At the same time it will declare all of the formerly
jaroslav@601
    40
 * weakly-reachable objects to be finalizable.  At the same time or at some
jaroslav@601
    41
 * later time it will enqueue those newly-cleared weak references that are
jaroslav@601
    42
 * registered with reference queues.
jaroslav@601
    43
 *
jaroslav@601
    44
 * @author   Mark Reinhold
jaroslav@601
    45
 * @since    1.2
jaroslav@601
    46
 */
jaroslav@601
    47
jaroslav@601
    48
public class WeakReference<T> extends Reference<T> {
jaroslav@601
    49
jaroslav@601
    50
    /**
jaroslav@601
    51
     * Creates a new weak reference that refers to the given object.  The new
jaroslav@601
    52
     * reference is not registered with any queue.
jaroslav@601
    53
     *
jaroslav@601
    54
     * @param referent object the new weak reference will refer to
jaroslav@601
    55
     */
jaroslav@601
    56
    public WeakReference(T referent) {
jaroslav@601
    57
        super(referent);
jaroslav@601
    58
    }
jaroslav@601
    59
jaroslav@601
    60
    /**
jaroslav@601
    61
     * Creates a new weak reference that refers to the given object and is
jaroslav@601
    62
     * registered with the given queue.
jaroslav@601
    63
     *
jaroslav@601
    64
     * @param referent object the new weak reference will refer to
jaroslav@601
    65
     * @param q the queue with which the reference is to be registered,
jaroslav@601
    66
     *          or <tt>null</tt> if registration is not required
jaroslav@601
    67
     */
jaroslav@601
    68
    public WeakReference(T referent, ReferenceQueue<? super T> q) {
jaroslav@601
    69
        super(referent, q);
jaroslav@601
    70
    }
jaroslav@601
    71
jaroslav@601
    72
}