| com.vividsolutions.jump.task.TaskMonitor
All known Subclasses: com.vividsolutions.jump.workbench.ui.task.TaskMonitorDialog, com.vividsolutions.jump.task.PrintStreamTaskMonitor, com.vividsolutions.jump.task.DummyTaskMonitor,
| TaskMonitor | | public interface TaskMonitor (Code) | | Provides a simple interface between an operation (or "task") and the
application in which it executes. Enables the task to report its progress,
and to check whether the application has requested that it be cancelled.
|
| Method Summary | |
| public void | allowCancellationRequests()
Notifies parties that the task will accept requests for cancellation
(though the task is not obligated to cancel immediately, or at all
for that matter). | | public boolean | isCancelRequested()
Checks whether a party has requested that the task be cancelled. | | public void | report(String description)
Describes the status of the task. | | public void | report(int itemsDone, int totalItems, String itemDescription)
Reports the number of items processed. | | public void | report(Exception exception)
Reports an Exception that occurred. |
| allowCancellationRequests | | public void allowCancellationRequests()(Code) | | Notifies parties that the task will accept requests for cancellation
(though the task is not obligated to cancel immediately, or at all
for that matter).
|
| isCancelRequested | | public boolean isCancelRequested()(Code) | | Checks whether a party has requested that the task be cancelled. However,
the task is not obligated to cancel immediately (or at all).
whether a party has requested that the task be cancelled |
| report | | public void report(String description)(Code) | | Describes the status of the task.
Parameters:
description - a description of the progress of the overall task |
| report | | public void report(int itemsDone, int totalItems, String itemDescription)(Code) | | Reports the number of items processed.
Parameters:
itemsDone - the number of items that have been processed
Parameters:
totalItems - the total number of items being processed, or -1 if thetotal number is not known
Parameters:
itemDescription - a one-word description of the items, such as "features" |
| report | | public void report(Exception exception)(Code) | | Reports an Exception that occurred. The task may choose to carry on.
Parameters:
exception - an Exception that occurred during the execution of the task. |
|
|