net.openhft.chronicle.core.threads

Class ThreadLocalHelper

java.lang.Object

net.openhft.chronicle.core.threads.ThreadLocalHelper

public final class ThreadLocalHelper
extends Object

A utility class for managing values in a ThreadLocal.

This class provides helper methods for fetching values from ThreadLocal, taking care of initializing the value if not present.

Method Summary

Modifier and Type	Method and Description
static <T> T	getSTL(@NotNull ThreadLocal<T> threadLocal, @NotNull Supplier<T> supplier) Retrieves a thread-local value, or creates a new one using a supplier if none exists.
static <T,A> T	getTL(@NotNull ThreadLocal<WeakReference<T>> threadLocal, A a, @NotNull Function<A,T> function) Retrieves a thread-local weakly-referenced value, or creates a new one using a function if none exists.
static <T,A> T	getTL(@NotNull ThreadLocal<WeakReference<T>> threadLocal, A supplyingEntity, @NotNull Function<A,T> constructor, @Nullable ReferenceQueue<T> referenceQueue, @Nullable Consumer<WeakReference<T>> registrar) Retrieves a thread-local weakly-referenced value, or creates a new one using a function if none exists.
static <T> T	getTL(@NotNull ThreadLocal<WeakReference<T>> threadLocal, @NotNull Supplier<T> supplier) Retrieves a thread-local weakly-referenced value, or creates a new one using a supplier if none exists.

Methods inherited from class java.lang.Object

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

Method Detail

getTL

@NotNull
public static <T> T getTL(@NotNull
                                   @NotNull ThreadLocal<WeakReference<T>> threadLocal,
                                   @NotNull
                                   @NotNull Supplier<T> supplier)

Retrieves a thread-local weakly-referenced value, or creates a new one using a supplier if none exists.

Type Parameters:

T - The type of the value.

Parameters:

threadLocal - The ThreadLocal object to retrieve or create a value for.

supplier - The supplier to generate a new value if necessary.

Returns:

The retrieved or newly created value.

getSTL

@NotNull
public static <T> T getSTL(@NotNull
                                    @NotNull ThreadLocal<T> threadLocal,
                                    @NotNull
                                    @NotNull Supplier<T> supplier)

Retrieves a thread-local value, or creates a new one using a supplier if none exists.

Type Parameters:

T - The type of the value.

Parameters:

threadLocal - The ThreadLocal object to retrieve or create a value for.

supplier - The supplier to generate a new value if necessary.

Returns:

The retrieved or newly created value.

getTL

@NotNull
public static <T,A> T getTL(@NotNull
                                     @NotNull ThreadLocal<WeakReference<T>> threadLocal,
                                     A a,
                                     @NotNull
                                     @NotNull Function<A,T> function)

Retrieves a thread-local weakly-referenced value, or creates a new one using a function if none exists.

Type Parameters:

T - The type of the value.

A - The type of the input to the function.

Parameters:

threadLocal - The ThreadLocal object to retrieve or create a value for.

a - The input for the function to generate a new value if necessary.

function - The function to generate a new value if necessary.

Returns:

The retrieved or newly created value.

getTL

@NotNull
public static <T,A> T getTL(@NotNull
                                     @NotNull ThreadLocal<WeakReference<T>> threadLocal,
                                     @NotNull
                                     A supplyingEntity,
                                     @NotNull
                                     @NotNull Function<A,T> constructor,
                                     @Nullable
                                     @Nullable ReferenceQueue<T> referenceQueue,
                                     @Nullable
                                     @Nullable Consumer<WeakReference<T>> registrar)

Retrieves a thread-local weakly-referenced value, or creates a new one using a function if none exists. Allows for the registration of the newly created weak reference in a reference queue via a registrar consumer.

Type Parameters:

T - The type of the value.

A - The type of the input to the function.

Parameters:

threadLocal - The ThreadLocal object to retrieve or create a value for.

supplyingEntity - The input for the function to generate a new value if necessary.

constructor - The function to generate a new value if necessary.

referenceQueue - The reference queue to register the weak reference in.

registrar - The consumer to use for registration of the weak reference.

Returns:

The retrieved or newly created value.