com.alibaba.ttl

Class TtlRunnable

java.lang.Object

com.alibaba.ttl.TtlRunnable

All Implemented Interfaces:

Runnable

public final class TtlRunnable
extends Object
implements Runnable

TtlRunnable decorate Runnable, so as to get TransmittableThreadLocal and transmit it to the time of Runnable execution, needed when use Runnable to thread pool.

Use factory method get(Runnable) to create instance.

Since:

0.9.0

Author:

Jerry Lee (oldratlee at gmail dot com)

See Also:

Executor, ExecutorService, ThreadPoolExecutor, ScheduledThreadPoolExecutor, Executors

Method Summary

Modifier and Type	Method and Description
static TtlRunnable	get(Runnable runnable) Factory method, wrapper input Runnable to TtlRunnable.
static TtlRunnable	get(Runnable runnable, boolean releaseTtlValueReferenceAfterRun) Factory method, wrapper input Runnable to TtlRunnable.
static TtlRunnable	get(Runnable runnable, boolean releaseTtlValueReferenceAfterRun, boolean idempotent) Factory method, wrapper input Runnable to TtlRunnable.
Runnable	getRunnable() return original/unwrapped Runnable.
static List<TtlRunnable>	gets(Collection<? extends Runnable> tasks) wrapper input Runnable Collection to TtlRunnable Collection.
static List<TtlRunnable>	gets(Collection<? extends Runnable> tasks, boolean releaseTtlValueReferenceAfterRun) wrapper input Runnable Collection to TtlRunnable Collection.
static List<TtlRunnable>	gets(Collection<? extends Runnable> tasks, boolean releaseTtlValueReferenceAfterRun, boolean idempotent) wrapper input Runnable Collection to TtlRunnable Collection.
void	run() wrap method Runnable.run().

Methods inherited from class java.lang.Object

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

Method Detail

run

public void run()

wrap method Runnable.run().

Specified by:

run in interface Runnable

getRunnable

public Runnable getRunnable()

return original/unwrapped Runnable.

get

public static TtlRunnable get(Runnable runnable)

Factory method, wrapper input Runnable to TtlRunnable.

This method is idempotent.

Parameters:

runnable - input Runnable. if input is null, return null.

Returns:

Wrapped Runnable

Throws:

IllegalStateException - when input is TtlRunnable already.

get

public static TtlRunnable get(Runnable runnable,
                              boolean releaseTtlValueReferenceAfterRun)

Factory method, wrapper input Runnable to TtlRunnable.

This method is idempotent.

Parameters:

runnable - input Runnable. if input is null, return null.

releaseTtlValueReferenceAfterRun - release TTL value reference after run, avoid memory leak even if TtlRunnable is referred.

Returns:

Wrapped Runnable

Throws:

IllegalStateException - when input is TtlRunnable already.

get

public static TtlRunnable get(Runnable runnable,
                              boolean releaseTtlValueReferenceAfterRun,
                              boolean idempotent)

Factory method, wrapper input Runnable to TtlRunnable.

This method is idempotent.

Parameters:

runnable - input Runnable. if input is null, return null.

releaseTtlValueReferenceAfterRun - release TTL value reference after run, avoid memory leak even if TtlRunnable is referred.

idempotent - is idempotent or not. if , return input object when it's TtlRunnable, or throw IllegalStateException. true will cover up bugs! DO NOT set, only when you know why.

Returns:

Wrapped Runnable

Throws:

IllegalStateException

gets

public static List<TtlRunnable> gets(Collection<? extends Runnable> tasks)

wrapper input Runnable Collection to TtlRunnable Collection.

Parameters:

tasks - task to be wrapped. if input is null, return null.

Returns:

wrapped tasks

Throws:

IllegalStateException - when input is TtlRunnable already.

gets

public static List<TtlRunnable> gets(Collection<? extends Runnable> tasks,
                                     boolean releaseTtlValueReferenceAfterRun)

wrapper input Runnable Collection to TtlRunnable Collection.

Parameters:

tasks - task to be wrapped. if input is null, return null.

releaseTtlValueReferenceAfterRun - release TTL value reference after run, avoid memory leak even if TtlRunnable is referred.

Returns:

wrapped tasks

Throws:

IllegalStateException - when input is TtlRunnable already.

gets

public static List<TtlRunnable> gets(Collection<? extends Runnable> tasks,
                                     boolean releaseTtlValueReferenceAfterRun,
                                     boolean idempotent)

wrapper input Runnable Collection to TtlRunnable Collection.

Parameters:

tasks - task to be wrapped. if input is null, return null.

releaseTtlValueReferenceAfterRun - release TTL value reference after run, avoid memory leak even if TtlRunnable is referred.

idempotent - is idempotent or not. if , return input object when it's TtlRunnable, or throw IllegalStateException. true will cover up bugs! DO NOT set, only when you know why.

Returns:

wrapped tasks

Throws:

IllegalStateException