Package com.alibaba.ttl

Class TtlTimerTask

java.lang.Object

java.util.TimerTask

com.alibaba.ttl.TtlTimerTask

All Implemented Interfaces:

TtlEnhanced, TtlWrapper<TimerTask>, Runnable

@Deprecated
public final class TtlTimerTask
extends TimerTask
implements TtlWrapper<TimerTask>, TtlEnhanced

Deprecated.

Use TtlRunnable, ScheduledExecutorService instead of Timer, TimerTask.

TtlTimerTask decorate TimerTask to get TransmittableThreadLocal value and transmit it to the time of TtlTimerTask execution, needed when use TtlTimerTask to TimerTask.

Use factory method get(TimerTask) to create instance.

NOTE: The TtlTimerTask make the method TimerTask.scheduledExecutionTime() in the origin TimerTask lose effectiveness! Use TtlAgent instead.

Since:

0.9.1

Author:

Jerry Lee (oldratlee at gmail dot com)

See Also:

• Timer
• TimerTask
• Alibaba Java Coding Guidelines - Concurrency - Item 10: [Mandatory] Run multiple TimeTask by using ScheduledExecutorService rather than Timer because Timer will kill all running threads in case of failing to catch exceptions.
• TtlAgent

Method Summary

Modifier and Type	Method	Description
boolean	cancel()	Deprecated.
boolean	equals(Object o)	Deprecated.
static TtlTimerTask	get(TimerTask timerTask)	Deprecated. Factory method, wrap input TimerTask to TtlTimerTask.
static TtlTimerTask	get(TimerTask timerTask, boolean releaseTtlValueReferenceAfterRun)	Deprecated. Factory method, wrap input TimerTask to TtlTimerTask.
static TtlTimerTask	get(TimerTask timerTask, boolean releaseTtlValueReferenceAfterRun, boolean idempotent)	Deprecated. Factory method, wrap input TimerTask to TtlTimerTask.
TimerTask	getTimerTask()	Deprecated. return original/unwrapped TimerTask.
int	hashCode()	Deprecated.
void	run()	Deprecated. wrap method TimerTask.run().
String	toString()	Deprecated.
TimerTask	unwrap()	Deprecated. unwrap to original/unwrapped TimerTask.
static TimerTask	unwrap(TimerTask timerTask)	Deprecated. Unwrap TtlTimerTask to the original/underneath one.
static List<TimerTask>	unwraps(Collection<? extends TimerTask> tasks)	Deprecated. Unwrap TtlTimerTask to the original/underneath one.

Methods inherited from class java.util.TimerTask

scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Method Details

run

public void run()

Deprecated.

wrap method TimerTask.run().

Specified by:

run in interface Runnable

Specified by:

run in class TimerTask

cancel

public boolean cancel()

Deprecated.

Overrides:

cancel in class TimerTask

getTimerTask

@NonNull
public TimerTask getTimerTask()

Deprecated.

return original/unwrapped TimerTask.

unwrap

@NonNull
public TimerTask unwrap()

Deprecated.

unwrap to original/unwrapped TimerTask.

Specified by:

unwrap in interface TtlWrapper<TimerTask>

Since:

2.11.4

See Also:

• TtlUnwrap.unwrap(Object)

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

get

@Nullable
@Contract(value="null -> null; !null -> !null",
          pure=true)
public static TtlTimerTask get(@Nullable
 TimerTask timerTask)

Deprecated.

Factory method, wrap input TimerTask to TtlTimerTask.

This method is idempotent.

Parameters:

timerTask - input TimerTask

Returns:

Wrapped TimerTask

get

@Nullable
@Contract(value="null, _ -> null; !null, _ -> !null",
          pure=true)
public static TtlTimerTask get(@Nullable
 TimerTask timerTask,
 boolean releaseTtlValueReferenceAfterRun)

Deprecated.

Factory method, wrap input TimerTask to TtlTimerTask.

This method is idempotent.

Parameters:

timerTask - input TimerTask

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

Returns:

Wrapped TimerTask

get

@Nullable
@Contract(value="null, _, _ -> null; !null, _, _ -> !null",
          pure=true)
public static TtlTimerTask get(@Nullable
 TimerTask timerTask,
 boolean releaseTtlValueReferenceAfterRun,
 boolean idempotent)

Deprecated.

Factory method, wrap input TimerTask to TtlTimerTask.

This method is idempotent.

Parameters:

timerTask - input TimerTask

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

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

Returns:

Wrapped TimerTask

unwrap

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

Deprecated.

Unwrap TtlTimerTask to the original/underneath one.

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

Since:

2.10.2

See Also:

• get(TimerTask)

unwraps

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

Deprecated.

Unwrap TtlTimerTask to the original/underneath one.

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

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

Since:

2.10.2

See Also:

• unwrap(TimerTask)