sample/java.lang.ref.Reference.txt

   1 *java.lang.ref.Reference* *Reference* Abstract base class for reference objects.
   2
   3 public abstract class Reference
   4   extends    |java.lang.Object|
   5
   6 |java.lang.ref.Reference_Description|
   7 |java.lang.ref.Reference_Fields|
   8 |java.lang.ref.Reference_Constructors|
   9 |java.lang.ref.Reference_Methods|
  10
  11 ================================================================================
  12
  13 *java.lang.ref.Reference_Methods*
  14 |java.lang.ref.Reference.clear()|Clears this reference object.
  15 |java.lang.ref.Reference.enqueue()|Adds this reference object to the queue with
  16 |java.lang.ref.Reference.get()|Returns this reference object's referent.
  17 |java.lang.ref.Reference.isEnqueued()|Tells whether or not this reference objec
  18
  19 *java.lang.ref.Reference_Description*
  20
  21 Abstract base class for reference objects. This class defines the operations
  22 common to all reference objects.        Because reference objects are implemented in
  23 close cooperation with the garbage collector, this class may not be subclassed
  24 directly.
  25
  26
  27 *java.lang.ref.Reference.clear()*
  28
  29 public void clear()
  30
  31 Clears this reference object. Invoking this method will not cause this object
  32 to be enqueued.
  33
  34
  35 *java.lang.ref.Reference.enqueue()*
  36
  37 public boolean enqueue()
  38
  39 Adds this reference object to the queue with which it is registered, if any.
  40
  41
  42     Returns: true if this reference object was successfully enqueued; false if it was
  43              already enqueued or if it was not registered with a queue when it
  44              was created
  45 *java.lang.ref.Reference.get()*
  46
  47 public |java.lang.Object| get()
  48
  49 Returns this reference object's referent. If this reference object has been
  50 cleared, either by the program or by the garbage collector, then this method
  51 returns null.
  52
  53
  54     Returns: The object to which this reference refers, or null if this reference object has
  55              been cleared
  56 *java.lang.ref.Reference.isEnqueued()*
  57
  58 public boolean isEnqueued()
  59
  60 Tells whether or not this reference object has been enqueued, either by the
  61 program or by the garbage collector. If this reference object was not
  62 registered with a queue when it was created, then this method will always
  63 return false.
  64
  65
  66     Returns: true if and only if this reference object has been enqueued
  67