com.jenjinstudios.io.concurrency

Class RecurringTask<T extends ExecutionContext>

java.lang.Object

com.jenjinstudios.io.concurrency.RecurringTask<T>

public abstract class RecurringTask<T extends ExecutionContext>
extends java.lang.Object

Represents a task with access to an ExecutionContext that should be repeated at a given interval until it is cancelled.

Constructor Summary

Constructors

Constructor and Description
RecurringTask() Construct a RecurringTask that should execute roughly once per second.
RecurringTask(long interval) Construct a RecurringTask that will execute roughly once every interval milliseconds.
RecurringTask(java.util.concurrent.TimeUnit timeUnit) Construct a RecurringTask that should execute roughly once per the time unit specified.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this task; after this method is called, the task will not be run again.
abstract void	execute(T context) This method is invoked by the execution thread when at least the number of milliseconds specified by getInterval have passed since the last time it was executed.
long	getInterval()
boolean	isCancelled()
boolean	isPaused()
boolean	isSkipped()
void	pause() Pause this task; it will not be executed again until it is resumed.
void	resume() Resume this task; if it is currently paused, it will begin executing at it's regular interval again.
void	skip() Skip the next execution of this task.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecurringTask

public RecurringTask()

Construct a RecurringTask that should execute roughly once per second.

RecurringTask

public RecurringTask(java.util.concurrent.TimeUnit timeUnit)

Construct a RecurringTask that should execute roughly once per the time unit specified.

Parameters:

timeUnit - The time unit that should pass between each execution. Note that no time unit will ever cause this task to be executed faster that once per millisecond. Also note that this specifies the minimum unit of time that must pass before the next time this task executes.

RecurringTask

public RecurringTask(long interval)

Construct a RecurringTask that will execute roughly once every interval milliseconds.

Parameters:

interval - The number of milliseconds that should have passed between executions of this task. Note that is the minimum number of milliseconds; more may pass between each execution.

Method Detail

getInterval

public final long getInterval()

execute

public abstract void execute(T context)

This method is invoked by the execution thread when at least the number of milliseconds specified by getInterval have passed since the last time it was executed.

Parameters:

context - The ExecutionContext provided to this RecurringTask, specific to the execution thread on which it was scheduled.

cancel

public void cancel()

Cancel this task; after this method is called, the task will not be run again.

isCancelled

public boolean isCancelled()

isPaused

public boolean isPaused()

isSkipped

public boolean isSkipped()

pause

public void pause()

Pause this task; it will not be executed again until it is resumed.

resume

public void resume()

Resume this task; if it is currently paused, it will begin executing at it's regular interval again.

skip

public void skip()

Skip the next execution of this task.