Package com.alibaba.ttl

Class TtlCallable<V>

java.lang.Object

com.alibaba.ttl.TtlCallable<V>

All Implemented Interfaces:

TtlAttachments, TtlEnhanced, TtlWrapper<Callable<V>>, Callable<V>

public final class TtlCallable<V>
extends Object
implements Callable<V>, TtlWrapper<Callable<V>>, TtlEnhanced, TtlAttachments

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

Use factory method get(Callable) to get decorated 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, CompletionService, ExecutorCompletionService

Field Summary

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

KEY_IS_AUTO_WRAPPER

Method Summary

Modifier and Type	Method	Description
V	call()	wrap method Callable.call().
boolean	equals(Object o)
static <T> TtlCallable<T>	get(Callable<T> callable)	Factory method, wrap input Callable to TtlCallable.
static <T> TtlCallable<T>	get(Callable<T> callable, boolean releaseTtlValueReferenceAfterCall)	Factory method, wrap input Callable to TtlCallable.
static <T> TtlCallable<T>	get(Callable<T> callable, boolean releaseTtlValueReferenceAfterCall, boolean idempotent)	Factory method, wrap input Callable to TtlCallable.
Callable<V>	getCallable()	return the original/underneath Callable.
static <T> List<TtlCallable<T>>	gets(Collection<? extends Callable<T>> tasks)	wrap input Callable Collection to TtlCallable Collection.
static <T> List<TtlCallable<T>>	gets(Collection<? extends Callable<T>> tasks, boolean releaseTtlValueReferenceAfterCall)	wrap input Callable Collection to TtlCallable Collection.
static <T> List<TtlCallable<T>>	gets(Collection<? extends Callable<T>> tasks, boolean releaseTtlValueReferenceAfterCall, boolean idempotent)	wrap input Callable Collection to TtlCallable Collection.
<T> T	getTtlAttachment(String key)	see TtlAttachments.getTtlAttachment(String)
int	hashCode()
void	setTtlAttachment(String key, Object value)	see TtlAttachments.setTtlAttachment(String, Object)
String	toString()
Callable<V>	unwrap()	unwrap to the original/underneath Callable.
static <T> Callable<T>	unwrap(Callable<T> callable)	Unwrap TtlCallable to the original/underneath one.
static <T> List<Callable<T>>	unwraps(Collection<? extends Callable<T>> tasks)	Unwrap TtlCallable to the original/underneath one.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

call

public V call()
       throws Exception

wrap method Callable.call().

Specified by:

call in interface Callable<V>

Throws:

Exception

getCallable

@NonNull
public Callable<V> getCallable()

return the original/underneath Callable.

unwrap

@NonNull
public Callable<V> unwrap()

unwrap to the original/underneath Callable.

Specified by:

unwrap in interface TtlWrapper<V>

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 <T> TtlCallable<T> get(@Nullable
                                     Callable<T> callable)

Factory method, wrap input Callable to TtlCallable.

This method is idempotent.

Parameters:

callable - input Callable

Returns:

Wrapped Callable

get

@Nullable
public static <T> TtlCallable<T> get(@Nullable
                                     Callable<T> callable,
                                     boolean releaseTtlValueReferenceAfterCall)

Factory method, wrap input Callable to TtlCallable.

This method is idempotent.

Parameters:

callable - input Callable

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

Returns:

Wrapped Callable

get

@Nullable
public static <T> TtlCallable<T> get(@Nullable
                                     Callable<T> callable,
                                     boolean releaseTtlValueReferenceAfterCall,
                                     boolean idempotent)

Factory method, wrap input Callable to TtlCallable.

This method is idempotent.

Parameters:

callable - input Callable

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

idempotent - is idempotent or not. true will cover up bugs! DO NOT set, only when you know why.

Returns:

Wrapped Callable

gets

@NonNull
public static <T> List<TtlCallable<T>> gets(@Nullable
                                            Collection<? extends Callable<T>> tasks)

wrap input Callable Collection to TtlCallable Collection.

Parameters:

tasks - task to be wrapped

Returns:

Wrapped Callable

gets

@NonNull
public static <T> List<TtlCallable<T>> gets(@Nullable
                                            Collection<? extends Callable<T>> tasks,
                                            boolean releaseTtlValueReferenceAfterCall)

wrap input Callable Collection to TtlCallable Collection.

Parameters:

tasks - task to be wrapped

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

Returns:

Wrapped Callable

gets

@NonNull
public static <T> List<TtlCallable<T>> gets(@Nullable
                                            Collection<? extends Callable<T>> tasks,
                                            boolean releaseTtlValueReferenceAfterCall,
                                            boolean idempotent)

wrap input Callable Collection to TtlCallable Collection.

Parameters:

tasks - task to be wrapped

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

idempotent - is idempotent or not. true will cover up bugs! DO NOT set, only when you know why.

Returns:

Wrapped Callable

unwrap

@Nullable
public static <T> Callable<T> unwrap(@Nullable
                                     Callable<T> callable)

Unwrap TtlCallable to the original/underneath one.

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

so TtlCallable.unwrap(TtlCallable.get(callable)) will always return the same input callable object.

Since:

2.10.2

See Also:

get(Callable), TtlUnwrap.unwrap(Object)

unwraps

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

Unwrap TtlCallable to the original/underneath one.

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

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

Since:

2.10.2

See Also:

gets(Collection), unwrap(Callable)

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