fixed some formatting typos
[vimdoclet.git] / sample / java.lang.ref.WeakReference.txt
blobd7e0ff574840def86244554df5016273ba0dabef
1 *java.lang.ref.WeakReference* *WeakReference* Weak reference objects, which do n
3 public class WeakReference<T>
4   extends    |java.lang.ref.Reference|
6 |java.lang.ref.WeakReference_Description|
7 |java.lang.ref.WeakReference_Fields|
8 |java.lang.ref.WeakReference_Constructors|
9 |java.lang.ref.WeakReference_Methods|
11 ================================================================================
13 *java.lang.ref.WeakReference_Constructors*
14 |java.lang.ref.WeakReference(T)|Creates a new weak reference that refers to the
15 |java.lang.ref.WeakReference(T,ReferenceQueue<?superT>)|Creates a new weak refe
17 *java.lang.ref.WeakReference_Description*
19 Weak reference objects, which do not prevent their referents from being made 
20 finalizable, finalized, and then reclaimed. Weak references are most often used 
21 to implement canonicalizing mappings. 
23 Suppose that the garbage collector determines at a certain point in time that 
24 an object is weakly reachable. At that time it will atomically clear all weak 
25 references to that object and all weak references to any other weakly-reachable 
26 objects from which that object is reachable through a chain of strong and soft 
27 references. At the same time it will declare all of the formerly 
28 weakly-reachable objects to be finalizable. At the same time or at some later 
29 time it will enqueue those newly-cleared weak references that are registered 
30 with reference queues. 
34 *java.lang.ref.WeakReference(T)*
36 public WeakReference(T referent)
38 Creates a new weak reference that refers to the given object. The new reference 
39 is not registered with any queue. 
41     referent - object the new weak reference will refer to 
43 *java.lang.ref.WeakReference(T,ReferenceQueue<?superT>)*
45 public WeakReference(
46   T referent,
47   java.lang.ref.ReferenceQueue<? super T> q)
49 Creates a new weak reference that refers to the given object and is registered 
50 with the given queue. 
52     referent - object the new weak reference will refer to 
53     q - the queue with which the reference is to be registered, or null if registration 
54        is not required