java.lang.ref

Class SoftReference<T>


public class SoftReference<T>
extends Reference<T>

A soft reference will be cleared, if the object is only softly reachable and the garbage collection needs more memory. The garbage collection will use an intelligent strategy to determine which soft references it should clear. This makes a soft reference ideal for caches.

Constructor Summary

SoftReference(T referent)
Create a new soft reference, that is not registered to any queue.
SoftReference(T referent, T> q)
Create a new soft reference.

Method Summary

T
get()
Returns the object, this reference refers to.

Methods inherited from class java.lang.ref.Reference<T>

clear, enqueue, get, isEnqueued

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SoftReference

public SoftReference(T referent)
Create a new soft reference, that is not registered to any queue.
Parameters:
referent - the object we refer to.

SoftReference

public SoftReference(T referent,
                     T> q)
Create a new soft reference.
Parameters:
referent - the object we refer to.
q - the reference queue to register on.
Throws:
NullPointerException - if q is null.

Method Details

get

public T get()
Returns the object, this reference refers to.
Overrides:
get in interface Reference<T>
Returns:
the object, this reference refers to, or null if the reference was cleared.

java.lang.ref.SoftReference Copyright (C) 1999, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.