Class InheritableThreadLocal
java.lang
java.lang.Object
  java.lang.ThreadLocal<T>
      java.lang.InheritableThreadLocal

public class InheritableThreadLocal
extends ThreadLocal<T>
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.

Since:
1.2
Version:
1.22, 11/17/05
Author:
Josh Bloch and Doug Lea
See Also:
ThreadLocal

Constructor Summary
InheritableThreadLocal()
Method Summary
protected T
childValue(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.
Methods inherited from class java.lang.ThreadLocal
get, initialValue, remove, set
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructor Detail
InheritableThreadLocal
public InheritableThreadLocal()
Method Detail
childValue
protected T childValue(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.

Parameters:
parentValue - the parent thread's value
Returns:
the child thread's initial value
Java API documentation generated with DocFlex/Doclet v1.5.6
DocFlex/Doclet is both a multi-format Javadoc doclet and a free edition of DocFlex/Javadoc. If you need to customize your Javadoc without writing a full-blown doclet from scratch, DocFlex/Javadoc may be the only tool able to help you! Find out more at www.docflex.com