to top
Android APIs
public class

ThreadLocal

extends Object
java.lang.Object
   ↳ java.lang.ThreadLocal<T>
Known Direct Subclasses

Class Overview

Implements a thread-local storage, that is, a variable for which each thread has its own value. All threads share the same ThreadLocal object, but each sees a different value when accessing it, and changes made by one thread do not affect the other threads. The implementation supports null values.

See Also

Summary

Public Constructors
ThreadLocal()
Creates a new thread-local variable.
Public Methods
T get()
Returns the value of this variable for the current thread.
void remove()
Removes the entry for this variable in the current thread.
void set(T value)
Sets the value of this variable for the current thread.
Protected Methods
T initialValue()
Provides the initial value of this variable for the current thread.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ThreadLocal ()

Added in API level 1

Creates a new thread-local variable.

Public Methods

public T get ()

Added in API level 1

Returns the value of this variable for the current thread. If an entry doesn't yet exist for this variable on this thread, this method will create an entry, populating the value with the result of initialValue().

Returns
  • the current value of the variable for the calling thread.

public void remove ()

Added in API level 1

Removes the entry for this variable in the current thread. If this call is followed by a get() before a set(T), #get() will call initialValue() and create a new entry with the resulting value.

public void set (T value)

Added in API level 1

Sets the value of this variable for the current thread. If set to null, the value will be set to null and the underlying entry will still be present.

Parameters
value the new value of the variable for the caller thread.

Protected Methods

protected T initialValue ()

Added in API level 1

Provides the initial value of this variable for the current thread. The default implementation returns null.

Returns
  • the initial value of the variable.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.