libjava/doc/java-lang-ref.texi

   1 @deftypemethod PhantomReference {public Object} get ()
   2 Returns the object, this reference refers to.
   3 @end deftypemethod
   4 @deftypemethod Reference {public Object} get ()
   5 Returns the object, this reference refers to.
   6 @end deftypemethod
   7 @deftypemethod Reference {public void} clear ()
   8 Clears the reference, so that it doesn't refer to its object
   9  anymore.  For soft and weak references this is called by the
  10  garbage collection.  For phantom references you should call
  11  this when enqueuing the reference.
  12 @end deftypemethod
  13 @deftypemethod Reference {public boolean} isEnqueued ()
  14 Tells if the object is enqueued on a reference queue.
  15 @end deftypemethod
  16 @deftypemethod Reference {public boolean} enqueue ()
  17 Enqueue an object on a reference queue.  This is normally executed
  18  by the garbage collection.
  19 @end deftypemethod
  20 @deftypemethod ReferenceQueue {public synchronized Reference} poll ()
  21 Checks if there is a reference on the queue, returning it
  22  immediately.  The reference will be dequeued.
  23 @end deftypemethod
  24 @deftypemethod ReferenceQueue {public synchronized Reference} remove (long@w{ }@var{timeout}) @*throws InterruptedException
  25 Removes a reference from the queue, blocking for @code{timeout}
  26  until a reference is enqueued.
  27 @end deftypemethod
  28 @deftypemethod ReferenceQueue {public Reference} remove () @*throws InterruptedException
  29 Removes a reference from the queue, blocking until a reference is
  30  enqueued.
  31 @end deftypemethod
  32 @deftypemethod SoftReference {public Object} get ()
  33 Returns the object, this reference refers to.
  34 @end deftypemethod