net.fortytwo.ripple.control

Class Task

java.lang.Object

net.fortytwo.ripple.control.Task

Direct Known Subclasses:

Command, TaskQueue

public abstract class Task
extends Object

Constructor Summary

Constructors

Constructor and Description
Task()

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(Task child) Adds a child task.
void	begin() Note: should not be called outside of Scheduler.
void	execute()
protected abstract void	executeProtected()
void	stop() Note: it is possible to stop a task which has already finished executing (the effect is to stop any children which may still be executing).
protected abstract void	stopProtected()
void	waitUntilFinished() Blocks until this task has finished.

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Method Detail

executeProtected

protected abstract void executeProtected()
                                  throws RippleException

Throws:

RippleException

stopProtected

protected abstract void stopProtected()

execute

public void execute()
             throws RippleException

Throws:

RippleException

stop

public void stop()

Note: it is possible to stop a task which has already finished executing (the effect is to stop any children which may still be executing).

begin

public void begin()

Note: should not be called outside of Scheduler.

addChild

public void addChild(Task child)

Adds a child task. Note: should not be called outside of Scheduler.

Parameters:

child - the task to add

waitUntilFinished

public void waitUntilFinished()
                       throws RippleException

Blocks until this task has finished.

Throws:

RippleException - if things go astray