Skip to content

Most visited

Recently visited

navigation
Added in API level 1

ReferenceQueue

public class ReferenceQueue
extends Object

java.lang.Object
   ↳ java.lang.ref.ReferenceQueue<T>


The ReferenceQueue is the container on which reference objects are enqueued when the garbage collector detects the reachability type specified for the referent.

Summary

Public constructors

ReferenceQueue()

Constructs a new instance of this class.

Public methods

Reference<? extends T> poll()

Returns the next available reference from the queue, removing it in the process.

Reference<? extends T> remove()

Returns the next available reference from the queue, removing it in the process.

Reference<? extends T> remove(long timeoutMillis)

Returns the next available reference from the queue, removing it in the process.

Inherited methods

From class java.lang.Object

Public constructors

ReferenceQueue

Added in API level 1
ReferenceQueue ()

Constructs a new instance of this class.

Public methods

poll

Added in API level 1
Reference<? extends T> poll ()

Returns the next available reference from the queue, removing it in the process. Does not wait for a reference to become available.

Returns
Reference<? extends T> the next available reference, or null if no reference is immediately available

remove

Added in API level 1
Reference<? extends T> remove ()

Returns the next available reference from the queue, removing it in the process. Waits indefinitely for a reference to become available.

Returns
Reference<? extends T>
Throws
InterruptedException if the blocking call was interrupted

remove

Added in API level 1
Reference<? extends T> remove (long timeoutMillis)

Returns the next available reference from the queue, removing it in the process. Waits for a reference to become available or the given timeout period to elapse, whichever happens first.

Parameters
timeoutMillis long: maximum time to spend waiting for a reference object to become available. A value of 0 results in the method waiting indefinitely.
Returns
Reference<? extends T> the next available reference, or null if no reference becomes available within the timeout period
Throws
IllegalArgumentException if timeoutMillis < 0.
InterruptedException if the blocking call was interrupted
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.