org.projectnyx.ticker

Class Task

java.lang.Object

org.projectnyx.ticker.Task

public class Task
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	RUN_INFINITY
static int	RUN_ONCE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Task(int ticks, int runCount) Superclass constructor for subclasses.
	Task(int delayTicks, int repeatInterval, int runCount, Runnable runnable) Creates a Task that stores the timing parameters for a task
	Task(int repeatInterval, int runCount, Runnable runnable) Creates a Task that stores the timing parameters for a task

Method Summary

Modifier and Type	Method and Description
void	addSelf()
int	getInterval()
Runnable	getRunnable()
int	getRunsLeft()
void	removeTask()
protected void	run()
Task	setRunnable(Runnable runnable)
void	tick()

Methods inherited from class java.lang.Object

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

Field Detail

RUN_INFINITY

public static final int RUN_INFINITY

See Also:

Constant Field Values

RUN_ONCE

public static final int RUN_ONCE

See Also:

Constant Field Values

Constructor Detail

Task

protected Task(int ticks,
               int runCount)

Superclass constructor for subclasses.

Parameters:

ticks - number of ticks before the task runs the first time, as well as the repeating interval of the task cycle, in ticks.

runCount - number of times to run the task. Pass RUN_INFINITY to run an indefinite number of times.

Task

public Task(int repeatInterval,
            int runCount,
            Runnable runnable)

Creates a Task that stores the timing parameters for a task

Parameters:

repeatInterval - number of ticks before the task runs the first time, as well as the repeating interval of the task cycle, in ticks.

runCount - number of times to run the task. Pass RUN_INFINITY to run an indefinite number of times.

runnable - the task to run

Task

public Task(int delayTicks,
            int repeatInterval,
            int runCount,
            Runnable runnable)

Creates a Task that stores the timing parameters for a task

Parameters:

delayTicks - number of ticks before the the first time this task is run. Start counting from the current tick (if Ticker has started ticking). Pass 0 or 1 to run the task in the current tick (if Ticker has started ticking).

repeatInterval - the repeating interval of the task cycle, in ticks.

runCount - number of times to run the task. Pass RUN_INFINITY to run an indefinite number of times.

runnable - the task to run, or null if this class is overriden

Method Detail

tick

public void tick()

run

protected void run()

removeTask

public void removeTask()

addSelf

public void addSelf()

getInterval

public int getInterval()

getRunsLeft

public int getRunsLeft()

getRunnable

public Runnable getRunnable()

setRunnable

public Task setRunnable(Runnable runnable)