org.colomoto.common.task

Class AbstractTask<T>

java.lang.Object

java.lang.Thread

org.colomoto.common.task.AbstractTask<T>

All Implemented Interfaces:

Runnable, Callable<T>, Task<T>

Direct Known Subclasses:

AbstractToolTask, BaseExporter, BaseLoader, BaseModifier, FixpointSearcher

public abstract class AbstractTask<T>
extends Thread
implements Task<T>

Helper class implementing the boring part of a Task. Implementors should check the canceled field to detect interruptions.

Author:

Aurelien Naldi

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canceled

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractTask()

Method Summary

Modifier and Type	Method and Description
void	background(TaskListener listener) Run the task in a separate thread.
T	call()
void	cancel() Mark the task as canceled.
T	getResult() Retrieve the result of the task.
TaskStatus	getStatus() Retrieve the status of the task.
protected abstract T	performTask() Placeholder for the actual implementation.
void	run()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.colomoto.common.task.Task

setParameter, setParameters, setParameters

Field Detail

canceled

protected boolean canceled

Constructor Detail

AbstractTask

public AbstractTask()

Method Detail

performTask

protected abstract T performTask()
                          throws Exception

Placeholder for the actual implementation.

Returns:

the result of the computation

Throws:

Exception - forwarded from the call() method

getResult

public T getResult()

Description copied from interface: Task

Retrieve the result of the task. This will NOT run the task, use call() to run and retrieve.

Specified by:

getResult in interface Task<T>

Returns:

the result of the task (null if stopped of canceled).

getStatus

public TaskStatus getStatus()

Description copied from interface: Task

Retrieve the status of the task.

Specified by:

getStatus in interface Task<T>

Returns:

the current status

call

public T call()
       throws Exception

Specified by:

call in interface Callable<T>

Throws:

Exception

cancel

public void cancel()

Description copied from interface: Task

Mark the task as canceled. Depending on the implementation,it may not stop the task immediately, but when the task will next check for the canceled status. It will thus not work with stuck tasks.

Specified by:

cancel in interface Task<T>

background

public void background(TaskListener listener)

Description copied from interface: Task

Run the task in a separate thread. The listener will be notified when the task is finished.

Specified by:

background in interface Task<T>

Parameters:

listener - will be notified when the task is done

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread