Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.lang.ref

Class ReferenceQueue<T>

public class ReferenceQueue<T>
extends Object
This is the queue, where references can enqueue themselve on. Each reference may be registered to a queue at initialization time and will be appended to the queue, when the enqueue method is called. The enqueue method may be automatically called by the garbage collector if it detects, that the object is only reachable through the Reference objects.
See Also:
Reference.enqueue()

Constructor Summary

ReferenceQueue()
Creates a new empty reference queue.

Method Summary

Reference
extends T> poll()
Checks if there is a reference on the queue, returning it immediately.
Reference
extends T> remove()
Removes a reference from the queue, blocking until a reference is enqueued.
Reference
extends T> remove(long timeout)
Removes a reference from the queue, blocking for timeout until a reference is enqueued.

Methods inherited from class java.lang.Object

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

Constructor Details

ReferenceQueue

public ReferenceQueue()
Creates a new empty reference queue.

Method Details

extends T> poll

public Referenceextends T> poll()
Checks if there is a reference on the queue, returning it immediately. The reference will be dequeued.
Returns:
a reference on the queue, if there is one, null otherwise.

extends T> remove

public Referenceextends T> remove()
            throws InterruptedException
Removes a reference from the queue, blocking until a reference is enqueued.
Returns:
the reference removed from the queue.
Throws:
InterruptedException - if the wait was interrupted.

extends T> remove

public Referenceextends T> remove(long timeout)
            throws InterruptedException
Removes a reference from the queue, blocking for timeout until a reference is enqueued.
Parameters:
timeout - the timeout period in milliseconds, 0 means wait forever.
Returns:
the reference removed from the queue, or null if timeout period expired.
Throws:
InterruptedException - if the wait was interrupted.
java.lang.ref.ReferenceQueue Copyright (C) 1999, 2004, 2006 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.

Overview Package Class Use Source Tree Index Deprecated About