Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.lang.ref.ReferenceQueue

java.lang.Object
    |
    +----java.lang.ref.ReferenceQueue

public class ReferenceQueue
extends Object
Reference queues, to which registered reference objects are appended by the garbage collector after the appropriate reachability changes are detected.

Since:
JDK1.2
See Also:
Reference

Constructor Summary
 ReferenceQueue()
Construct a new reference-object queue.
 

Method Summary
Reference  poll()
Poll this queue to see if a reference object is available, immediately returning one if so.
Reference  remove(long timeout)
Remove the next reference object in this queue, blocking until either one becomes available or the given timeout period expires.
Reference  remove()
Remove the next reference object in this queue, blocking until one becomes available.
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReferenceQueue

public ReferenceQueue()
Construct a new reference-object queue.
Method Detail

poll

public Reference poll()
Poll this queue to see if a reference object is available, immediately returning one if so. If the queue is empty, then immediately return null.
Returns:
A reference, if one was immediately available, otherwise null.

remove

public Reference remove(long timeout) throws IllegalArgumentException, InterruptedException
Remove the next reference object in this queue, blocking until either one becomes available or the given timeout period expires.
Parameters:
timeout - If positive, block for up timeout milliseconds while waiting for a reference to be added to this queue. If zero, block indefinitely.
Returns:
A reference, if one was available, otherwise null.
Throws:
IllegalArgumentException - If the value of the timeout argument is negative
InterruptedException - If the timeout wait is interrupted

remove

public Reference remove() throws InterruptedException
Remove the next reference object in this queue, blocking until one becomes available.
Throws:
InterruptedException - If the wait is interrupted

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.