Class ThreadLocal<T>
- Direct Known Subclasses:
InheritableThreadLocal
public class ThreadLocal<T> extends Object
get
or set
method) has its own, independently initialized copy of the variable. ThreadLocal
instances are typically private static fields in classes that wish to associate state with a thread (e.g., a user ID or Transaction ID). For example, the class below generates unique identifiers local to each thread. A thread's id is assigned the first time it invokes ThreadId.get()
and remains unchanged on subsequent calls.
import java.util.concurrent.atomic.AtomicInteger; public class ThreadId { // Atomic integer containing the next thread ID to be assigned private static final AtomicInteger nextId = new AtomicInteger(0); // Thread local variable containing each thread's ID private static final ThreadLocal<Integer> threadId = new ThreadLocal<Integer>() { @Override protected Integer initialValue() { return nextId.getAndIncrement(); } }; // Returns the current thread's unique ID, assigning it if necessary public static int get() { return threadId.get(); } }
Each thread holds an implicit reference to its copy of a thread-local variable as long as the thread is alive and the ThreadLocal
instance is accessible; after a thread goes away, all of its copies of thread-local instances are subject to garbage collection (unless other references to these copies exist).
- Since:
- 1.2
Constructor Summary
Constructor | Description |
---|---|
ThreadLocal() |
Creates a thread local variable. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
T |
get() |
Returns the value in the current thread's copy of this thread-local variable. |
protected T |
initialValue() |
Returns the current thread's "initial value" for this thread-local variable. |
void |
remove() |
Removes the current thread's value for this thread-local variable. |
void |
set |
Sets the current thread's copy of this thread-local variable to the specified value. |
static <S> ThreadLocal<S> |
withInitial |
Creates a thread local variable. |
Constructor Details
ThreadLocal
public ThreadLocal()
- See Also:
Method Details
initialValue
protected T initialValue()
get()
method, unless the thread previously invoked the set(T)
method, in which case the initialValue
method will not be invoked for the thread. Normally, this method is invoked at most once per thread, but it may be invoked again in case of subsequent invocations of remove()
followed by get()
. This implementation simply returns null
; if the programmer desires thread-local variables to have an initial value other than null
, ThreadLocal
must be subclassed, and this method overridden. Typically, an anonymous inner class will be used.
- Returns:
- the initial value for this thread-local
withInitial
public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier)
get
method on the Supplier
.- Type Parameters:
-
S
- the type of the thread local's value - Parameters:
-
supplier
- the supplier to be used to determine the initial value - Returns:
- a new thread local variable
- Throws:
-
NullPointerException
- if the specified supplier is null - Since:
- 1.8
get
public T get()
initialValue()
method.- Returns:
- the current thread's value of this thread-local
set
public void set(T value)
initialValue()
method to set the values of thread-locals.- Parameters:
-
value
- the value to be stored in the current thread's copy of this thread-local.
remove
public void remove()
initialValue()
method, unless its value is set by the current thread in the interim. This may result in multiple invocations of the initialValue
method in the current thread.- Since:
- 1.5
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ThreadLocal.html