sample/java.lang.ref.ReferenceQueue.txt

   1 *java.lang.ref.ReferenceQueue* *ReferenceQueue* Reference queues, to which regis
   2
   3 public class ReferenceQueue<T>
   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
  28 *java.lang.ref.ReferenceQueue()*
  29
  30 public ReferenceQueue()
  31
  32 Constructs a new reference-object queue.
  33
  34
  35 *java.lang.ref.ReferenceQueue.poll()*
  36
  37 public |java.lang.ref.Reference|<? extends T> poll()
  38
  39 Polls this queue to see if a reference object is available. If one is available
  40 without further delay then it is removed from the queue and returned. Otherwise
  41 this method immediately returns null.
  42
  43
  44
  45     Returns: A reference object, if one was immediately available, otherwise null
  46
  47 *java.lang.ref.ReferenceQueue.remove()*
  48
  49 public |java.lang.ref.Reference|<? extends T> remove()
  50   throws |java.lang.InterruptedException|
  51
  52 Removes the next reference object in this queue, blocking until one becomes
  53 available.
  54
  55
  56
  57     Returns: A reference object, blocking until one becomes available
  58
  59 *java.lang.ref.ReferenceQueue.remove(long)*
  60
  61 public |java.lang.ref.Reference|<? extends T> remove(long timeout)
  62   throws |java.lang.IllegalArgumentException|
  63          |java.lang.InterruptedException|
  64
  65 Removes the next reference object in this queue, blocking until either one
  66 becomes available or the given timeout period expires.
  67
  68 This method does not offer real-time guarantees: It schedules the timeout as if
  69 by invoking the (|java.lang.Object|) method.
  70
  71
  72     timeout - If positive, block for up to timeout milliseconds while waiting for a reference
  73        to be added to this queue. If zero, block indefinitely.
  74
  75     Returns: A reference object, if one was available within the specified timeout period,
  76              otherwise null
  77
  78