com.goldencode.p2j.util

Class ProtectedTimerTask

java.lang.Object

com.goldencode.p2j.util.ProtectedTimerTask

All Implemented Interfaces:

java.lang.Comparable<java.util.concurrent.Delayed>, java.lang.Runnable, java.util.concurrent.Delayed

public abstract class ProtectedTimerTask
extends java.lang.Object
implements java.util.concurrent.Delayed, java.lang.Runnable

A task that can be scheduled for one-time or repeated execution by a ProtectedTimer.

Implementations of this class should be designed to catch and handle OutOfMemoryError to the degree possible.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ProtectedTimerTask.TaskStatus Possible task states.

Field Summary

Fields

Modifier and Type	Field and Description
private long	nextExecutionTime Absolute time (in milliseconds) of the next execution of the task.
private long	periodicalDelay Interval between the subsequent executions of the task.
private ProtectedTimerTask.TaskStatus	taskStatus Current task status.

Constructor Summary

Constructors

Constructor and Description
ProtectedTimerTask()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the task.
int	compareTo(java.util.concurrent.Delayed delayed) Compares the delay of this timer task with the delay of the specified task.
long	getDelay(java.util.concurrent.TimeUnit timeUnit) Returns the remaining delay associated with this timer task, in the given time unit.
(package private) void	initialSchedule(long initialDelay, long periodicalDelay) Prepares the task for its initial execution.
boolean	isCancelled() Determines whether this task is cancelled.
(package private) boolean	reschedule() Prepares the task for the next execution.
abstract void	run() Main task code.

Methods inherited from class java.lang.Object

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

Field Detail

taskStatus

private ProtectedTimerTask.TaskStatus taskStatus

Current task status.

periodicalDelay

private long periodicalDelay

Interval between the subsequent executions of the task.

nextExecutionTime

private long nextExecutionTime

Absolute time (in milliseconds) of the next execution of the task.

Constructor Detail

ProtectedTimerTask

public ProtectedTimerTask()

Method Detail

run

public abstract void run()

Main task code. Should be implemented into subclasses.

Specified by:

run in interface java.lang.Runnable

getDelay

public long getDelay(java.util.concurrent.TimeUnit timeUnit)

Returns the remaining delay associated with this timer task, in the given time unit.

Specified by:

getDelay in interface java.util.concurrent.Delayed

Parameters:

timeUnit - the time unit

Returns:

the remaining delay; zero or negative values indicate that the delay has already elapsed

compareTo

public int compareTo(java.util.concurrent.Delayed delayed)

Compares the delay of this timer task with the delay of the specified task. Returns a negative integer, zero, or a positive integer as delay of this task is less than, equal to, or greater than the delay of the specified task.

Specified by:

compareTo in interface java.lang.Comparable<java.util.concurrent.Delayed>

Parameters:

delayed - the timer task which delay should be compared to the delay of this task.

Returns:

a negative integer, zero, or a positive integer as delay of this task is less than, equal to, or greater than the delay of the specified task.

cancel

public void cancel()

Cancels the task.

isCancelled

public boolean isCancelled()

Determines whether this task is cancelled.

Returns:

See above.

initialSchedule

void initialSchedule(long initialDelay,
                     long periodicalDelay)

Prepares the task for its initial execution.

Parameters:

initialDelay - Delay before execution of the task.

periodicalDelay - Interval between the subsequent executions of the task.

reschedule

boolean reschedule()

Prepares the task for the next execution.

Returns:

true if the task was successfully rescheduled. false if task is completed and shouldn't be rescheduled.