org.colomoto.common.task

Interface Task<T>

All Superinterfaces:

Callable<T>

All Known Subinterfaces:

ModelExporter, ModelLoader, ModelModifier, ModelTask, ToolTask<R>

All Known Implementing Classes:

AbstractPNEncoder, AbstractTask, AbstractToolTask, BaseExporter, BaseLoader, BaseModifier, BNetExport, BNetImport, BooleanFunctionExport, BooleanFunctionImport, BooleanizeModifier, BooleanNetExport, BooleanNetImport, BoolSimExport, BoolSimImport, BufferingModifier, CNetExport, CNetImport, FixpointSearcher, FixpointTask, GNAExport, ImplicantTableExport, ImplicantTableImport, MaBoSSEncoder, MNetExport, MNetImport, PatternReduction, PerturbationModifier, PintExport, PNEncoderAPNN, PNEncoderINA, PNEncoderPNML, RandomWalkTask, ReductionModifier, ReverseModifier, SanitizeModifier, SATAttractorFinder, SBMLqualExport, SBMLqualImport, SubmodelModifier, SubSpaceModifier, TraceTask, TrapSpaceTask, TruthTableExport, TruthTableImport

public interface Task<T>
extends Callable<T>

Simple task definition. A task can either be blocking (it will then return the result directly) or launched in background.

Author:

Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
void	background(TaskListener listener) Run the task in a separate thread.
void	cancel() Mark the task as canceled.
T	getResult() Retrieve the result of the task.
TaskStatus	getStatus() Retrieve the status of the task.
default void	setParameter(String param)
default void	setParameters(String parameters)
default void	setParameters(String[] parameters)

Methods inherited from interface java.util.concurrent.Callable

call

Method Detail

getResult

T getResult()

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

Returns:

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

getStatus

TaskStatus getStatus()

Retrieve the status of the task.

Returns:

the current status

cancel

void cancel()

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.

background

void background(TaskListener listener)

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

Parameters:

listener - will be notified when the task is done

setParameter

default void setParameter(String param)

setParameters

default void setParameters(String[] parameters)

setParameters

default void setParameters(String parameters)