- java.lang.Object
-
- java.lang.ref.ReferenceQueue<T>
-
public class ReferenceQueue<T> extends Object
Reference queues, to which registered reference objects are appended by the garbage collector after the appropriate reachability changes are detected.- Since:
- 1.2
-
-
Constructor Summary
Constructors Constructor and Description ReferenceQueue()
Constructs a new reference-object queue.
-
Method Summary
Methods Modifier and Type Method and Description Reference<? extends T>
poll()
Polls this queue to see if a reference object is available.Reference<? extends T>
remove()
Removes the next reference object in this queue, blocking until one becomes available.Reference<? extends T>
remove(long timeout)
Removes the next reference object in this queue, blocking until either one becomes available or the given timeout period expires.
-
-
-
Method Detail
-
poll
public Reference<? extends T> poll()
Polls this queue to see if a reference object is available. If one is available without further delay then it is removed from the queue and returned. Otherwise this method immediately returns null.- Returns:
- A reference object, if one was immediately available,
otherwise
null
-
remove
public Reference<? extends T> remove(long timeout) throws IllegalArgumentException, InterruptedException
Removes the next reference object in this queue, blocking until either one becomes available or the given timeout period expires.This method does not offer real-time guarantees: It schedules the timeout as if by invoking the
Object.wait(long)
method.- Parameters:
timeout
- If positive, block for up totimeout
milliseconds while waiting for a reference to be added to this queue. If zero, block indefinitely.- Returns:
- A reference object, if one was available within the specified
timeout period, otherwise
null
- Throws:
IllegalArgumentException
- If the value of the timeout argument is negativeInterruptedException
- If the timeout wait is interrupted
-
remove
public Reference<? extends T> remove() throws InterruptedException
Removes the next reference object in this queue, blocking until one becomes available.- Returns:
- A reference object, blocking until one becomes available
- Throws:
InterruptedException
- If the wait is interrupted
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/lang/ref/referencequeue.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.