de.aristaflow.adept2.model.runtimeenvironment

Interface ProgressMonitor

public interface ProgressMonitor

This interface have to be implemented by objects that are interested in providing the progress/execution state of a special task for interested parties.

Author:

Markus Lauer

Method Summary

Modifier and Type	Method and Description
void	beginTask() Informs the Progress Monitor about the start of a new job with an unknown or unspecified amount of work to be done.
void	beginTask(int overallWorkUnits) Informs the Progress Monitor about the start of a new job and provides an approximation for the amount of work to be done.
void	endTask() Informs the progress monitor about the termination of the current task.
void	progress() Increments the counter for the units of work that has already been processed.
void	setTaskState(TaskState taskState) Notify the progress monitor about the current state of the task.

Method Detail

beginTask

void beginTask()

Informs the Progress Monitor about the start of a new job with an unknown or unspecified amount of work to be done. This method may only be called once and excludes calling beginTask(int).

beginTask

void beginTask(int overallWorkUnits)

Informs the Progress Monitor about the start of a new job and provides an approximation for the amount of work to be done. This method may only be called once and excludes calling beginTask().

Parameters:

overallWorkUnits - The amount of work units to be done during the job.

progress

void progress()

Increments the counter for the units of work that has already been processed.

endTask

void endTask()

Informs the progress monitor about the termination of the current task. It doesn't matter if the task failed or ended successfully.

setTaskState

void setTaskState(TaskState taskState)

Notify the progress monitor about the current state of the task.

Parameters:

taskState - the state of the task