Package com.alibaba.ttl

Class TtlRunnable

java.lang.Object

com.alibaba.ttl.TtlRunnable

All Implemented Interfaces:

TtlAttachments, TtlEnhanced, TtlWrapper<Runnable>, Runnable

public final class TtlRunnable
extends Object
implements Runnable, TtlWrapper<Runnable>, TtlEnhanced, TtlAttachments

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.

Other TTL Wrapper for common Functional Interface see TtlWrappers.

Since:

0.9.0

Author:

Jerry Lee (oldratlee at gmail dot com)

See Also:

TtlExecutors, TtlWrappers, Executor, ExecutorService, ThreadPoolExecutor, ScheduledThreadPoolExecutor, Executors

Field Summary

Fields inherited from interface com.alibaba.ttl.spi.TtlAttachments

KEY_IS_AUTO_WRAPPER

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static TtlRunnable	get(Runnable runnable)	Factory method, wrap input Runnable to TtlRunnable.
static TtlRunnable	get(Runnable runnable, boolean releaseTtlValueReferenceAfterRun)	Factory method, wrap input Runnable to TtlRunnable.
static TtlRunnable	get(Runnable runnable, boolean releaseTtlValueReferenceAfterRun, boolean idempotent)	Factory method, wrap input Runnable to TtlRunnable.
Runnable	getRunnable()	return original/unwrapped Runnable.
static List<TtlRunnable>	gets(Collection<? extends Runnable> tasks)	wrap input Runnable Collection to TtlRunnable Collection.
static List<TtlRunnable>	gets(Collection<? extends Runnable> tasks, boolean releaseTtlValueReferenceAfterRun)	wrap input Runnable Collection to TtlRunnable Collection.
static List<TtlRunnable>	gets(Collection<? extends Runnable> tasks, boolean releaseTtlValueReferenceAfterRun, boolean idempotent)	wrap input Runnable Collection to TtlRunnable Collection.
<T> T	getTtlAttachment(String key)	see TtlAttachments.getTtlAttachment(String)
int	hashCode()
void	run()	wrap method Runnable.run().
void	setTtlAttachment(String key, Object value)	see TtlAttachments.setTtlAttachment(String, Object)
String	toString()
Runnable	unwrap()	unwrap to original/unwrapped Runnable.
static Runnable	unwrap(Runnable runnable)	Unwrap TtlRunnable to the original/underneath one.
static List<Runnable>	unwraps(Collection<? extends Runnable> tasks)	Unwrap TtlRunnable to the original/underneath one for collection.

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

@NonNull
public Runnable getRunnable()

return original/unwrapped Runnable.

unwrap

@NonNull
public Runnable unwrap()

unwrap to original/unwrapped Runnable.

Specified by:

unwrap in interface TtlWrapper<Runnable>

Since:

2.11.4

See Also:

TtlUnwrap.unwrap(Object)

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

@Nullable
public static TtlRunnable get(@Nullable
                              Runnable runnable)

Factory method, wrap 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

@Nullable
public static TtlRunnable get(@Nullable
                              Runnable runnable,
                              boolean releaseTtlValueReferenceAfterRun)

Factory method, wrap 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

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

Factory method, wrap 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

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

wrap 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

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

wrap 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

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

wrap 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.

unwrap

@Nullable
public static Runnable unwrap(@Nullable
                              Runnable runnable)

Unwrap TtlRunnable to the original/underneath one.

this method is null-safe, when input Runnable parameter is null, return null; if input Runnable parameter is not a TtlRunnable just return input Runnable.

so TtlRunnable.unwrap(TtlRunnable.get(runnable)) will always return the same input runnable object.

Since:

2.10.2

See Also:

get(Runnable), TtlUnwrap.unwrap(Object)

unwraps

@NonNull
public static List<Runnable> unwraps(@Nullable
                                     Collection<? extends Runnable> tasks)

Unwrap TtlRunnable to the original/underneath one for collection.

Invoke unwrap(Runnable) for each element in input collection.

This method is null-safe, when input Runnable parameter collection is null, return a empty list.

Since:

2.10.2

See Also:

gets(Collection), unwrap(Runnable)

setTtlAttachment

public void setTtlAttachment(@NonNull
                             String key,
                             Object value)

see TtlAttachments.setTtlAttachment(String, Object)

Specified by:

setTtlAttachment in interface TtlAttachments

Parameters:

key - attachment key

value - attachment value

Since:

2.11.0

getTtlAttachment

public <T> T getTtlAttachment(@NonNull
                              String key)

see TtlAttachments.getTtlAttachment(String)

Specified by:

getTtlAttachment in interface TtlAttachments

Parameters:

key - attachment key

Since:

2.11.0