Package Summary  Overview Summary

class:ReferenceQueue [NONE]
Type Parameters:
T - the type of the reference object
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:ReferenceQueue() [NONE]

  • ReferenceQueue

    public ReferenceQueue()
    Constructs a new reference-object queue.

method:poll() [NONE]

  • 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

    • method:remove(long) [NONE]

    remove

    public Reference<? extends T>  remove (long timeout) throws 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 to timeout 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 negative
    InterruptedException - If the timeout wait is interrupted

    method:remove() [NONE]

    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

    © 2023 Oracle Corporation and/or its affiliates