Interface ProgressMonitor
-
public interface ProgressMonitorA progress monitor passed to aPluginFeaturethat allows reporting the progress of process.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidbeginTask(java.lang.String name, int totalWork)Notifies that the main task is beginning.booleanisCanceled()Call this method repeatedly to check, if the user wants to cancel the process.voidsetTaskName(java.lang.String name)voidworked(int work)Notifies that a given number of work unit of the main task has been completed.
-
-
-
Method Detail
-
isCanceled
boolean isCanceled()
Call this method repeatedly to check, if the user wants to cancel the process. Abort the process if this returnstrue.- Returns:
trueif the user has cancelled the process.
-
beginTask
void beginTask(java.lang.String name, int totalWork)Notifies that the main task is beginning.- Parameters:
name- the name of the current task shown to the user.totalWork- the total number of work units that will be done by the task.
-
setTaskName
void setTaskName(java.lang.String name)
- Parameters:
name- the name of the current task shown to the user.
-
worked
void worked(int work)
Notifies that a given number of work unit of the main task has been completed.- Parameters:
work- the number of work units just completed.
-
-