|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class ThreadLocal<T>
java.lang.ThreadLocal<T>
Direct Known Subclasses:
public class ThreadLocal<T>
This class provides thread-local variables. These variables differ from
their normal counterparts in that each thread that accesses one (via its
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
Author:
Josh Bloch and Doug Lea
Constructor Summary |
Creates a thread local variable.
|
Method Summary |
|
Returns the value in the current thread's copy of this
thread-local variable.
|
|
Returns the current thread's "initial value" for this
thread-local variable.
|
void |
Removes the current thread's value for this thread-local
variable.
|
void |
Sets the current thread's copy of this thread-local variable
to the specified value.
|
|
Creates a thread local variable.
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Creates a thread local variable.
See Also:
Returns the current thread's "initial value" for this
thread-local variable. This method will be invoked the first
time a thread accesses the variable with the
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
Creates a thread local variable. The initial value of the variable is
determined by invoking the
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:
Since:
1.8
Returns the value in the current thread's copy of this
thread-local variable. If the variable has no value for the
current thread, it is first initialized to the value returned
by an invocation of the
initialValue() method.
Returns:
the current thread's value of this thread-local
Sets the current thread's copy of this thread-local variable
to the specified value. Most subclasses will have no need to
override this method, relying solely on the
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.
Removes the current thread's value for this thread-local
variable. If this thread-local variable is subsequently
read by the current thread, its value will be
reinitialized by invoking its
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
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz