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 methods get(java.lang.Runnable) / gets(java.util.Collection<? extends java.lang.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
boolean	equals(Object o)
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.
int	hashCode()
void	run() wrap method Runnable.run().
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

get

public static TtlRunnable get(Runnable runnable)

Factory method, wrapper input Runnable to TtlRunnable.

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.

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.

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 mode or not. if true, just return input Runnable when it's TtlRunnable, otherwise throw IllegalStateException. Caution: true will cover up bugs! DO NOT set, only when you know why.

Returns:

Wrapped Runnable

Throws:

IllegalStateException - when input is TtlRunnable already and not idempotent.

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 mode or not. if true, just return input Runnable when it's TtlRunnable, otherwise throw IllegalStateException. Caution: true will cover up bugs! DO NOT set, only when you know why.

Returns:

wrapped tasks

Throws:

IllegalStateException - when input is TtlRunnable already and not idempotent.