sample/java.lang.ref.Reference.txt

   1 *java.lang.ref.Reference* *Reference* Abstract base class for reference objects.
   2
   3 public abstract class Reference<T>
   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
  28 *java.lang.ref.Reference.clear()*
  29
  30 public void clear()
  31
  32 Clears this reference object. Invoking this method will not cause this object
  33 to be enqueued.
  34
  35 This method is invoked only by Java code; when the garbage collector clears
  36 references it does so directly, without invoking this method.
  37
  38
  39
  40 *java.lang.ref.Reference.enqueue()*
  41
  42 public boolean enqueue()
  43
  44 Adds this reference object to the queue with which it is registered, if any.
  45
  46 This method is invoked only by Java code; when the garbage collector enqueues
  47 references it does so directly, without invoking this method.
  48
  49
  50
  51     Returns: true if this reference object was successfully enqueued; false if it was
  52              already enqueued or if it was not registered with a queue when it
  53              was created
  54
  55 *java.lang.ref.Reference.get()*
  56
  57 public |T| get()
  58
  59 Returns this reference object's referent. If this reference object has been
  60 cleared, either by the program or by the garbage collector, then this method
  61 returns null.
  62
  63
  64
  65     Returns: The object to which this reference refers, or null if this reference object has
  66              been cleared
  67
  68 *java.lang.ref.Reference.isEnqueued()*
  69
  70 public boolean isEnqueued()
  71
  72 Tells whether or not this reference object has been enqueued, either by the
  73 program or by the garbage collector. If this reference object was not
  74 registered with a queue when it was created, then this method will always
  75 return false.
  76
  77
  78
  79     Returns: true if and only if this reference object has been enqueued
  80
  81