|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface can be implemented to return progress information from the file generation
process. This interface is loosely based on the standard Eclipse IProgressMonitor interface,
but does not implement all its methods.
During the execution of a long running method, Abator will call the
setNumberOfSubTasks
method first, and then repeatedly call startSubTaskfinished
.
Periodically, Abator will call checkCancel
to see if the method should
be cancelled.
Method Summary | |
void |
checkCancel()
Abator will call this method periodically during a long running method. |
void |
finished()
Abator calls this method when all subtasks are finished |
void |
setNumberOfSubTasks(int totalSubTasks)
Called to designate the maximum number of startSubTask messages that will be sent. |
void |
startSubTask(java.lang.String subTaskName)
Called to denote the beginning of another task |
Method Detail |
public void setNumberOfSubTasks(int totalSubTasks)
totalSubTasks
- public void startSubTask(java.lang.String subTaskName)
subTaskName
- a descriptive name of the current work steppublic void finished()
public void checkCancel() throws java.lang.InterruptedException
java.lang.InterruptedException
- if the main task should finish
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |