InheritableThreadLocal (Java Platform SE 8 ) (original) (raw)

• 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 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
See Also:
ThreadLocal

• • Constructor Summary

  Constructors

  Constructor	Description
  InheritableThreadLocal()

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  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](../../java/lang/ThreadLocal.html "class in java.lang")  
     `[get](../../java/lang/ThreadLocal.html#get--), [initialValue](../../java/lang/ThreadLocal.html#initialValue--), [remove](../../java/lang/ThreadLocal.html#remove--), [set](../../java/lang/ThreadLocal.html#set-T-), [withInitial](../../java/lang/ThreadLocal.html#withInitial-java.util.function.Supplier-)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### InheritableThreadLocal  
     public InheritableThreadLocal()  

  • Method Detail

    * #### childValue  
    protected [T](../../java/lang/InheritableThreadLocal.html "type parameter in InheritableThreadLocal") childValue([T](../../java/lang/InheritableThreadLocal.html "type parameter in InheritableThreadLocal") 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

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.