Build 1.1_r1 (from source)

java.lang.ref
Class ReferenceQueue<T>

java.lang.Object
  extended by java.lang.ref.ReferenceQueue<T>
Direct Known Subclasses:
ProcessManager.ProcessReferenceQueue

public class ReferenceQueue<T>
extends Object

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

Since:
Android 1.0

Constructor Summary
ReferenceQueue()
          Constructs a new instance of this class.
 
Method Summary
(package private)  void enqueue(Reference<? extends T> toQueue)
          Enqueues the reference object on the receiver.
 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 timeout)
          Returns the next available reference from the queue, removing it in the process.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReferenceQueue

public ReferenceQueue()
Constructs a new instance of this class.

Since:
Android 1.0
Method Detail

poll

public 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:
the next available reference, or null if no reference is immediately available
Since:
Android 1.0

remove

public Reference<? extends T> remove()
                              throws InterruptedException
Returns the next available reference from the queue, removing it in the process. Waits indefinitely for a reference to become available.

Returns:
the next available reference
Throws:
InterruptedException - if the blocking call was interrupted for some reason
Since:
Android 1.0

remove

public Reference<? extends T> remove(long timeout)
                              throws IllegalArgumentException,
                                     InterruptedException
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:
timeout - maximum time (in ms) to spend waiting for a reference object to become available. A value of zero results in the method waiting indefinitely.
Returns:
the next available reference, or null if no reference becomes available within the timeout period
Throws:
IllegalArgumentException - if the wait period is negative.
InterruptedException - if the blocking call was interrupted for some reason
Since:
Android 1.0

enqueue

void enqueue(Reference<? extends T> toQueue)
Enqueues the reference object on the receiver.

Parameters:
toQueue - reference object to be enqueued.
Since:
Android 1.0

Build 1.1_r1 (from source)

Please submit a feedback, bug or feature