org.scijava.task

Interface Task

All Superinterfaces:

Cancelable, Named

All Known Implementing Classes:

DefaultTask

public interface Task
extends Cancelable, Named

A self-aware job which reports its status and progress as it runs.

Author:

Curtis Rueden

Method Summary

Modifier and Type	Method and Description
long	getProgressMaximum() Gets the number of steps the task performs in total.
long	getProgressValue() Gets the step the task is currently performing.
String	getStatusMessage() Gets a status message describing what the task is currently doing.
boolean	isDone() Checks whether the task has completed.
void	run(Runnable r) Starts running the task.
void	setProgressMaximum(long max) Sets the total number of steps.
void	setProgressValue(long step) Sets the current step.
void	setStatusMessage(String status) Sets the status message.
void	waitFor() Waits for the task to complete.

Methods inherited from interface org.scijava.Cancelable

cancel, getCancelReason, isCanceled

Methods inherited from interface org.scijava.Named

getName, setName

Method Detail

run

void run(Runnable r)

Starts running the task.

Throws:

IllegalStateException - if the task was already started.

waitFor

void waitFor()
      throws InterruptedException,
             ExecutionException

Waits for the task to complete.

Throws:

IllegalStateException - if run(java.lang.Runnable) has not been called yet.

InterruptedException - if the task is interrupted.

ExecutionException - if the task throws an exception while running.

isDone

boolean isDone()

Checks whether the task has completed.

getStatusMessage

String getStatusMessage()

Gets a status message describing what the task is currently doing.

getProgressValue

long getProgressValue()

Gets the step the task is currently performing.

Returns:

A value between 0 and getProgressMaximum() inclusive.

See Also:

getProgressMaximum()

getProgressMaximum

long getProgressMaximum()

Gets the number of steps the task performs in total.

Returns:

Total number of steps the task will perform, or 0 if unknown.

See Also:

getProgressValue()

setStatusMessage

void setStatusMessage(String status)

Sets the status message. Called by task implementors.

Parameters:

status - The message to set.

See Also:

getStatusMessage()

setProgressValue

void setProgressValue(long step)

Sets the current step. Called by task implementors.

Parameters:

step - The step vaule to set.

See Also:

getProgressValue()

setProgressMaximum

void setProgressMaximum(long max)

Sets the total number of steps. Called by task implementors.

Parameters:

max - The step count to set.

See Also:

getProgressMaximum()