English | Site Directory

Android - An Open Handset Alliance Project

java.lang.ref
public class

java.lang.ref.ReferenceQueue

java.lang.Object
java.lang.ref.ReferenceQueue

ReferenceQueue is the container on which reference objects are enqueued when their reachability type is detected for the referent.

Summary

Public Constructors

          ReferenceQueue()
Constructs a new instance of this class.

Public Methods

  synchronized      Reference  poll()
Returns the next available reference from the queue if one is enqueued, null otherwise.
        Reference  remove()
Return the next available enqueued reference on the queue, blocking indefinitely until one is available.
  synchronized      Reference  remove(long timeout)
Return the next available enqueued reference on the queue, blocking up to the time given until one is available.
Methods inherited from class java.lang.Object

Details

Public Constructors

public ReferenceQueue()

Constructs a new instance of this class.

Public Methods

public synchronized Reference poll()

Returns the next available reference from the queue if one is enqueued, null otherwise. Does not wait for a reference to become available.

Returns

  • Reference next available Reference or NULL.

public Reference remove()

Return the next available enqueued reference on the queue, blocking indefinitely until one is available.

Returns

  • Reference a Reference object if one is available, null otherwise.

Throws

InterruptedException to interrupt the wait.

public synchronized Reference remove(long timeout)

Return the next available enqueued reference on the queue, blocking up to the time given until one is available. Return null if no reference became available.

Parameters

timeout maximum time spent waiting for a reference object to become available.

Returns

  • Reference a Reference object if one is available, null otherwise.

Throws

IllegalArgumentException if the wait period is negative. InterruptedException to interrupt the wait.
InterruptedException
Build m5-rc15i - 10 Jun 2008 13:54