1. Description
2. Constructor Summary
3. Method Summary
4. Constructor Details
   1. ReferenceQueue()
5. Method Details
   1. poll()
   2. remove(long)
   3. remove()

Type Parameters:

T - the type of the reference object

• Constructor Summary

  Constructors
  Constructor

  Description

  ReferenceQueue()

  Constructs a new reference-object queue.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  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.

  Methods declared in class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Details

  • ReferenceQueue

    public ReferenceQueue()

    Constructs a new reference-object queue.

• Method Details

  • 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

    See Also:

    • Reference.enqueue()

  • 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

    See Also:

    • Reference.enqueue()

  • 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

    See Also:

    • Reference.enqueue()

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.