FileDocCategorySizeDatePackage
InheritableThreadLocal.javaAPI DocJava SE 5 API2301Fri Aug 26 14:57:02 BST 2005java.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 inheritable thread-local variables 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.

Inheritable thread-local variables are used in preference to ordinary thread-local 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.

author
Josh Bloch and Doug Lea
version
1.21, 02/09/04
see
ThreadLocal
since
1.2

Fields Summary
Constructors Summary
Methods Summary
protected TchildValue(T parentValue)
Computes the child's initial value for this inheritable thread-local variable 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.

param
parentValue the parent thread's value
return
the child thread's initial value

        return parentValue;
    
voidcreateMap(java.lang.Thread t, T firstValue)
Create the map associated with a ThreadLocal.

param
t the current thread
param
firstValue value for the initial entry of the table.
param
map the map to store.

        t.inheritableThreadLocals = new ThreadLocalMap(this, firstValue);
    
ThreadLocalMapgetMap(java.lang.Thread t)
Get the map associated with a ThreadLocal.

param
t the current thread

       return t.inheritableThreadLocals;