Improved build.xml
[vimdoclet.git] / sample / java.lang.InheritableThreadLocal.txt
blob31ad0f9ed5c38b06ff4597ce62bf3741f3324e11
1 *java.lang.InheritableThreadLocal* *InheritableThreadLocal* This class extends T
3 public class InheritableThreadLocal
4   extends    |java.lang.ThreadLocal|
6 |java.lang.InheritableThreadLocal_Description|
7 |java.lang.InheritableThreadLocal_Fields|
8 |java.lang.InheritableThreadLocal_Constructors|
9 |java.lang.InheritableThreadLocal_Methods|
11 ================================================================================
13 *java.lang.InheritableThreadLocal_Constructors*
14 |java.lang.InheritableThreadLocal()|
16 *java.lang.InheritableThreadLocal_Methods*
17 |java.lang.InheritableThreadLocal.childValue(T)|Computes the child's initial va
19 *java.lang.InheritableThreadLocal_Description*
21 This class extends ThreadLocal to provide inheritance of values from parent 
22 thread to child thread: when a child thread is created, the child receives 
23 initial values for all inheritable thread-local variables for which the parent 
24 has values. Normally the child's values will be identical to the parent's; 
25 however, the child's value can be made an arbitrary function of the parent's by 
26 overriding the childValue method in this class. 
28 Inheritable thread-local variables are used in preference to ordinary 
29 thread-local variables when the per-thread-attribute being maintained in the 
30 variable (e.g., User ID, Transaction ID) must be automatically transmitted to 
31 any child threads that are created. 
34 *java.lang.InheritableThreadLocal()*
36 public InheritableThreadLocal()
41 *java.lang.InheritableThreadLocal.childValue(T)*
43 protected |java.lang.Object| childValue(java.lang.Object parentValue)
45 Computes the child's initial value for this inheritable thread-local variable 
46 as a function of the parent's value at the time the child thread is created. 
47 This method is called from within the parent thread before the child is 
48 started. 
50 This method merely returns its input argument, and should be overridden if a 
51 different behavior is desired. 
53     parentValue - the parent thread's value 
55     Returns: the child thread's initial value