Java Platform 1.2
Beta 4

Class java.lang.InheritableThreadLocal

java.lang.Object
  |
  +--java.lang.ThreadLocal
        |
        +--java.lang.InheritableThreadLocal

public class InheritableThreadLocal
extends ThreadLocal
This class extends ThreadLocal to provide inheritance of values from parent Thread to child Thread: when a child thread is created, the child receives initial values for all InheritableThreadLocals for which the parent has values. Normally the child's values will be identical to the parent's; however, the child's value can be made an arbitrary function of the parent's by overriding the childValue method in this class.

InheritableThreadLocal variables are used in preference to ordinary ThreadLocal variables when the per-thread-attribute being maintained in the variable (e.g., User ID, Transaction ID) must be automatically transmitted to any child threads that are created.

Since:
JDK1.2
See Also:
ThreadLocal

Constructor Summary
InheritableThreadLocal()
          Creates an InheritableThreadLocal variable.
 
Method Summary
protected  Object childValue(Object parentValue)
          Computes the child's initial value for this InheritableThreadLocal as a function of the parent's value at the time the child Thread is created.
 
Methods inherited from class java.lang.ThreadLocal
get , initialValue , set
 
Methods inherited from class java.lang.Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
 

Constructor Detail

InheritableThreadLocal

public InheritableThreadLocal()
Creates an InheritableThreadLocal variable.
Method Detail

childValue

protected Object childValue(Object parentValue)
Computes the child's initial value for this InheritableThreadLocal as a function of the parent's value at the time the child Thread is created. This method is called from within the parent thread before the child is started.

This method merely returns its input argument, and should be overridden if a different behavior is desired.


Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.