sample/java.lang.ref.ReferenceQueue.txt

   1 *java.lang.ref.ReferenceQueue* *ReferenceQueue* Reference queues, to which regis
   2
   3 public class ReferenceQueue
   4   extends    |java.lang.Object|
   5
   6 |java.lang.ref.ReferenceQueue_Description|
   7 |java.lang.ref.ReferenceQueue_Fields|
   8 |java.lang.ref.ReferenceQueue_Constructors|
   9 |java.lang.ref.ReferenceQueue_Methods|
  10
  11 ================================================================================
  12
  13 *java.lang.ref.ReferenceQueue_Constructors*
  14 |java.lang.ref.ReferenceQueue()|Constructs a new reference-object queue.
  15
  16 *java.lang.ref.ReferenceQueue_Methods*
  17 |java.lang.ref.ReferenceQueue.poll()|Polls this queue to see if a reference obj
  18 |java.lang.ref.ReferenceQueue.remove()|Removes the next reference object in thi
  19 |java.lang.ref.ReferenceQueue.remove(long)|Removes the next reference object in
  20
  21 *java.lang.ref.ReferenceQueue_Description*
  22
  23 Reference queues, to which registered reference objects are appended by the
  24 garbage collector after the appropriate reachability changes are detected.
  25
  26
  27 *java.lang.ref.ReferenceQueue()*
  28
  29 public ReferenceQueue()
  30
  31 Constructs a new reference-object queue.
  32
  33
  34 *java.lang.ref.ReferenceQueue.poll()*
  35
  36 public |java.lang.ref.Reference| poll()
  37
  38 Polls this queue to see if a reference object is available. If one is available
  39 without further delay then it is removed from the queue and returned. Otherwise
  40 this method immediately returns null.
  41
  42
  43     Returns: A reference object, if one was immediately available, otherwise null
  44 *java.lang.ref.ReferenceQueue.remove()*
  45
  46 public |java.lang.ref.Reference| remove()
  47   throws |java.lang.InterruptedException|
  48
  49 Removes the next reference object in this queue, blocking until one becomes
  50 available.
  51
  52
  53     Returns: A reference object, blocking until one becomes available
  54 *java.lang.ref.ReferenceQueue.remove(long)*
  55
  56 public |java.lang.ref.Reference| remove(long timeout)
  57   throws |java.lang.IllegalArgumentException|
  58          |java.lang.InterruptedException|
  59
  60 Removes the next reference object in this queue, blocking until either one
  61 becomes available or the given timeout period expires.
  62
  63 This method does not offer real-time guarantees: It schedules the timeout as if
  64 by invoking the (|java.lang.Object|) method.
  65
  66     timeout - If positive, block for up timeout milliseconds while waiting for a reference to
  67        be added to this queue. If zero, block indefinitely.
  68
  69     Returns: A reference object, if one was available within the specified timeout period,
  70              otherwise null
  71