net.openhft.chronicle.core.threads

Class CleaningThreadLocal<T>

java.lang.Object

java.lang.ThreadLocal<T>

net.openhft.chronicle.core.threads.CleaningThreadLocal<T>

Type Parameters:

T - The type of resource this CleaningThreadLocal holds.

public class CleaningThreadLocal<T>
extends ThreadLocal<T>

The CleaningThreadLocal class extends ThreadLocal and ensures that the resources held by a CleaningThread are cleaned up if the thread dies.

Note that this class does not clean up resources if the ThreadLocal instance itself is discarded.

Method Summary

Modifier and Type	Method and Description
void	cleanup(T value) Performs cleanup of the provided value.
static void	cleanupNonCleaningThreads() Cleans up resources held by threads that are no longer alive.
T	get() Returns the value of this CleaningThreadLocal.
protected T	initialValue() Returns the initial value of this CleaningThreadLocal.
void	remove() Removes the value for this CleaningThreadLocal from the current thread and performs cleanup.
void	set(T value) Sets the value of this CleaningThreadLocal and performs cleanup if necessary.
static <T> CleaningThreadLocal<T>	withCleanup(Supplier<T> supplier, ThrowingConsumer<T,Exception> cleanup) Creates a CleaningThreadLocal with a supplier and a custom cleanup strategy.
static <T> CleaningThreadLocal<T>	withCleanup(Supplier<T> supplier, ThrowingConsumer<T,Exception> cleanup, Function<T,T> getWrapper) Creates a CleaningThreadLocal with a supplier, a custom cleanup strategy, and a function to apply when the get method is called.
static <T> CleaningThreadLocal<T>	withCleanup(ThrowingConsumer<T,Exception> cleanup) Creates a CleaningThreadLocal with a custom cleanup strategy.
static <T> CleaningThreadLocal<T>	withCloseQuietly(Supplier<T> supplier) Creates a CleaningThreadLocal with a Closeable cleanup strategy.

Methods inherited from class java.lang.ThreadLocal

withInitial

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withCloseQuietly

public static <T> CleaningThreadLocal<T> withCloseQuietly(Supplier<T> supplier)

Creates a CleaningThreadLocal with a Closeable cleanup strategy.

Parameters:

supplier - The supplier that provides the resource.

Returns:

A CleaningThreadLocal instance.

withCleanup

public static <T> CleaningThreadLocal<T> withCleanup(ThrowingConsumer<T,Exception> cleanup)

Creates a CleaningThreadLocal with a custom cleanup strategy.

Parameters:

cleanup - The consumer that cleans up the resource.

Returns:

A CleaningThreadLocal instance.

withCleanup

public static <T> CleaningThreadLocal<T> withCleanup(Supplier<T> supplier,
                                                     ThrowingConsumer<T,Exception> cleanup)

Creates a CleaningThreadLocal with a supplier and a custom cleanup strategy.

Parameters:

supplier - The supplier that provides the resource.

cleanup - The consumer that cleans up the resource.

Returns:

A CleaningThreadLocal instance.

withCleanup

public static <T> CleaningThreadLocal<T> withCleanup(Supplier<T> supplier,
                                                     ThrowingConsumer<T,Exception> cleanup,
                                                     Function<T,T> getWrapper)

Creates a CleaningThreadLocal with a supplier, a custom cleanup strategy, and a function to apply when the get method is called.

Parameters:

supplier - The supplier that provides the resource.

cleanup - The consumer that cleans up the resource.

getWrapper - The function to apply when the get method is called.

Returns:

A CleaningThreadLocal instance.

cleanupNonCleaningThreads

public static void cleanupNonCleaningThreads()

Cleans up resources held by threads that are no longer alive.

initialValue

protected T initialValue()

Returns the initial value of this CleaningThreadLocal. This method is called once per thread when the thread first uses the get() method.

Overrides:

initialValue in class ThreadLocal<T>

Returns:

The initial value.

get

public T get()

Returns the value of this CleaningThreadLocal.

Overrides:

get in class ThreadLocal<T>

Returns:

The current value.

set

public void set(T value)

Sets the value of this CleaningThreadLocal and performs cleanup if necessary.

Overrides:

set in class ThreadLocal<T>

Parameters:

value - The new value to be set.

remove

public void remove()

Removes the value for this CleaningThreadLocal from the current thread and performs cleanup.

Overrides:

remove in class ThreadLocal<T>

cleanup

public void cleanup(T value)

Performs cleanup of the provided value. It can be safely called multiple times, as cleanup will only be performed the first time for a given value.

Parameters:

value - The value to be cleaned up.