Package com.alibaba.ttl.threadpool

Class TtlExecutors

java.lang.Object

com.alibaba.ttl.threadpool.TtlExecutors

public final class TtlExecutors
extends Object

Util methods for TTL wrapper of jdk executors.

1. wrap/check/unwrap methods for TTL wrapper of jdk executors(Executor, ExecutorService, ScheduledExecutorService).
2. wrap/check/unwrap methods for disable Inheritable wrapper of ThreadFactory.
3. wrap/check/unwrap methods for TtlRunnableUnwrapComparator wrapper of PriorityBlockingQueue.

Note:

• all method is null-safe. for wrap/unwrap methods when input parameter is null, return null. for check methods when input parameter is null, return false.
• skip wrap/decoration thread pool/executor(aka. just return input executor) when ttl agent is loaded, Or when input executor is already wrapped/decorated.

Since:

0.9.0

Author:

Jerry Lee (oldratlee at gmail dot com)

See Also:

Executor, ExecutorService, ScheduledExecutorService, ThreadPoolExecutor, ScheduledThreadPoolExecutor, Executors, CompletionService, ExecutorCompletionService, ThreadFactory, Executors.defaultThreadFactory(), PriorityBlockingQueue, TtlForkJoinPoolHelper

Method Summary

Modifier and Type	Method	Description
static ThreadFactory	getDefaultDisableInheritableThreadFactory()	Wrapper of Executors.defaultThreadFactory(), disable inheritable.
static ThreadFactory	getDisableInheritableThreadFactory(ThreadFactory threadFactory)	Wrapper of ThreadFactory, disable inheritable.
static Executor	getTtlExecutor(Executor executor)	TransmittableThreadLocal Wrapper of Executor, transmit the TransmittableThreadLocal from the task submit time of Runnable to the execution time of Runnable.
static ExecutorService	getTtlExecutorService(ExecutorService executorService)	TransmittableThreadLocal Wrapper of ExecutorService, transmit the TransmittableThreadLocal from the task submit time of Runnable or Callable to the execution time of Runnable or Callable.
static Comparator<Runnable>	getTtlRunnableUnwrapComparator(Comparator<Runnable> comparator)	Wrapper of Comparator<Runnable> which unwrap TtlRunnable before compare, aka TtlRunnableUnwrapComparator.
static Comparator<Runnable>	getTtlRunnableUnwrapComparatorForComparableRunnable()	TtlRunnableUnwrapComparator that compares Comparable objects.
static ScheduledExecutorService	getTtlScheduledExecutorService(ScheduledExecutorService scheduledExecutorService)	TransmittableThreadLocal Wrapper of ScheduledExecutorService, transmit the TransmittableThreadLocal from the task submit time of Runnable or Callable to the execution time of Runnable or Callable.
static boolean	isDisableInheritableThreadFactory(ThreadFactory threadFactory)	check the ThreadFactory is DisableInheritableThreadFactory or not.
static boolean	isTtlRunnableUnwrapComparator(Comparator<Runnable> comparator)	check the Comparator<Runnable> is a wrapper TtlRunnableUnwrapComparator or not.
static <T extends Executor> boolean	isTtlWrapper(T executor)	check the executor is a TTL executor wrapper or not.
static Comparator<Runnable>	unwrap(Comparator<Runnable> comparator)	Unwrap TtlRunnableUnwrapComparator to the original/underneath Comparator<Runnable>.
static ThreadFactory	unwrap(ThreadFactory threadFactory)	Unwrap DisableInheritableThreadFactory to the original/underneath one.
static <T extends Executor> T	unwrap(T executor)	Unwrap TTL executor wrapper to the original/underneath one.

Methods inherited from class java.lang.Object

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

Method Detail

getTtlExecutor

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static Executor getTtlExecutor(@Nullable
                                      Executor executor)

TransmittableThreadLocal Wrapper of Executor, transmit the TransmittableThreadLocal from the task submit time of Runnable to the execution time of Runnable.

NOTE: sine v2.12.0 the idempotency of return wrapped Executor is changed to true, so the wrapped Executor can be cooperated with the usage of "Decorate Runnable and Callable".

About idempotency: if is idempotent, it's allowed to submit the TtlRunnable/TtlCallable to the wrapped Executor; otherwise throw IllegalStateException.

Parameters:

executor - input Executor

Returns:

wrapped Executor

See Also:

TtlRunnable.get(Runnable, boolean, boolean), TtlCallable.get(Callable, boolean, boolean)

getTtlExecutorService

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static ExecutorService getTtlExecutorService(@Nullable
                                                    ExecutorService executorService)

TransmittableThreadLocal Wrapper of ExecutorService, transmit the TransmittableThreadLocal from the task submit time of Runnable or Callable to the execution time of Runnable or Callable.

NOTE: sine v2.12.0 the idempotency of return wrapped ExecutorService is changed to true, so the wrapped ExecutorService can be cooperated with the usage of "Decorate Runnable and Callable".

About idempotency: if is idempotent, it's allowed to submit the TtlRunnable/TtlCallable to the wrapped ExecutorService; otherwise throw IllegalStateException.

Parameters:

executorService - input ExecutorService

Returns:

wrapped ExecutorService

See Also:

TtlRunnable.get(Runnable, boolean, boolean), TtlCallable.get(Callable, boolean, boolean)

getTtlScheduledExecutorService

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static ScheduledExecutorService getTtlScheduledExecutorService(@Nullable
                                                                      ScheduledExecutorService scheduledExecutorService)

TransmittableThreadLocal Wrapper of ScheduledExecutorService, transmit the TransmittableThreadLocal from the task submit time of Runnable or Callable to the execution time of Runnable or Callable.

NOTE: sine v2.12.0 the idempotency of return wrapped ScheduledExecutorService is changed to true, so the wrapped ScheduledExecutorService can be cooperated with the usage of "Decorate Runnable and Callable".

About idempotency: if is idempotent, it's allowed to submit the TtlRunnable/TtlCallable to the wrapped ScheduledExecutorService; otherwise throw IllegalStateException.

Parameters:

scheduledExecutorService - input scheduledExecutorService

Returns:

wrapped scheduledExecutorService

See Also:

TtlRunnable.get(Runnable, boolean, boolean), TtlCallable.get(Callable, boolean, boolean)

isTtlWrapper

public static <T extends Executor> boolean isTtlWrapper(@Nullable
                                                        T executor)

check the executor is a TTL executor wrapper or not.

if the parameter executor is TTL wrapper, return true, otherwise false.

NOTE: if input executor is null, return false.

Type Parameters:

T - Executor type

Parameters:

executor - input executor

Since:

2.8.0

See Also:

getTtlExecutor(Executor), getTtlExecutorService(ExecutorService), getTtlScheduledExecutorService(ScheduledExecutorService), unwrap(Executor)

unwrap

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static <T extends Executor> T unwrap(@Nullable
                                            T executor)

Unwrap TTL executor wrapper to the original/underneath one.

if the parameter executor is TTL wrapper, return the original/underneath executor; otherwise, just return the input parameter executor.

NOTE: if input executor is null, return null.

Type Parameters:

T - Executor type

Parameters:

executor - input executor

Since:

2.8.0

See Also:

getTtlExecutor(Executor), getTtlExecutorService(ExecutorService), getTtlScheduledExecutorService(ScheduledExecutorService), isTtlWrapper(Executor), TtlUnwrap.unwrap(Object)

getDisableInheritableThreadFactory

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static ThreadFactory getDisableInheritableThreadFactory(@Nullable
                                                               ThreadFactory threadFactory)

Wrapper of ThreadFactory, disable inheritable.

Parameters:

threadFactory - input thread factory

Since:

2.10.0

See Also:

DisableInheritableThreadFactory, TtlForkJoinPoolHelper.getDisableInheritableForkJoinWorkerThreadFactory(java.util.concurrent.ForkJoinPool.ForkJoinWorkerThreadFactory)

getDefaultDisableInheritableThreadFactory

@NonNull
public static ThreadFactory getDefaultDisableInheritableThreadFactory()

Wrapper of Executors.defaultThreadFactory(), disable inheritable.

Since:

2.10.0

See Also:

getDisableInheritableThreadFactory(ThreadFactory), TtlForkJoinPoolHelper.getDefaultDisableInheritableForkJoinWorkerThreadFactory()

isDisableInheritableThreadFactory

public static boolean isDisableInheritableThreadFactory(@Nullable
                                                        ThreadFactory threadFactory)

check the ThreadFactory is DisableInheritableThreadFactory or not.

Since:

2.10.0

See Also:

TtlForkJoinPoolHelper.getDisableInheritableForkJoinWorkerThreadFactory(java.util.concurrent.ForkJoinPool.ForkJoinWorkerThreadFactory), getDefaultDisableInheritableThreadFactory(), DisableInheritableThreadFactory

unwrap

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static ThreadFactory unwrap(@Nullable
                                   ThreadFactory threadFactory)

Unwrap DisableInheritableThreadFactory to the original/underneath one.

Since:

2.10.0

See Also:

getDisableInheritableThreadFactory(ThreadFactory), getDefaultDisableInheritableThreadFactory(), isDisableInheritableThreadFactory(ThreadFactory), TtlForkJoinPoolHelper.unwrap(ForkJoinPool.ForkJoinWorkerThreadFactory), DisableInheritableThreadFactory, TtlUnwrap.unwrap(Object)

getTtlRunnableUnwrapComparator

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static Comparator<Runnable> getTtlRunnableUnwrapComparator(@Nullable
                                                                  Comparator<Runnable> comparator)

Wrapper of Comparator<Runnable> which unwrap TtlRunnable before compare, aka TtlRunnableUnwrapComparator.

Prepared for comparator parameter of constructor PriorityBlockingQueue(int, Comparator).

PriorityBlockingQueue can be used by constructor ThreadPoolExecutor(int, int, long, java.util.concurrent.TimeUnit, java.util.concurrent.BlockingQueue).

Parameters:

comparator - input comparator

Returns:

wrapped comparator

Since:

2.12.3

See Also:

ThreadPoolExecutor, ThreadPoolExecutor(int, int, long, java.util.concurrent.TimeUnit, java.util.concurrent.BlockingQueue), PriorityBlockingQueue, PriorityBlockingQueue(int, Comparator)

getTtlRunnableUnwrapComparatorForComparableRunnable

@NonNull
public static Comparator<Runnable> getTtlRunnableUnwrapComparatorForComparableRunnable()

TtlRunnableUnwrapComparator that compares Comparable objects.

Since:

2.12.3

See Also:

getTtlRunnableUnwrapComparator(Comparator)

isTtlRunnableUnwrapComparator

public static boolean isTtlRunnableUnwrapComparator(@Nullable
                                                    Comparator<Runnable> comparator)

check the Comparator<Runnable> is a wrapper TtlRunnableUnwrapComparator or not.

Since:

2.12.3

See Also:

getTtlRunnableUnwrapComparator(Comparator), getTtlRunnableUnwrapComparatorForComparableRunnable()

unwrap

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static Comparator<Runnable> unwrap(@Nullable
                                          Comparator<Runnable> comparator)

Unwrap TtlRunnableUnwrapComparator to the original/underneath Comparator<Runnable>.

Since:

2.12.3

See Also:

getTtlRunnableUnwrapComparator(Comparator), getTtlRunnableUnwrapComparatorForComparableRunnable(), isTtlRunnableUnwrapComparator(Comparator), TtlUnwrap.unwrap(Object)