Package com.marcosavard.commons.util

Interface ProgressMonitor

All Known Implementing Classes:

SimpleProgressMonitor

public interface ProgressMonitor

The ProgressMonitor interface is implemented by objects that monitor the progress of an activity; the methods in this interface are invoked by code that performs the activity. All activity is broken down into a linear sequence of tasks against which progress is reported. When a task begins, a beginTask(String, int) notification is reported, followed by any number and mixture of progress reports (worked()) and subtask notifications (subTask(String)). When the task is eventually completed, a done() notification is reported. After the done() notification, the progress monitor cannot be reused; i.e., beginTask(String, int) cannot be called again after the call to done(). A request to cancel an operation can be signaled using the setCanceled method. Operations taking a progress monitor are expected to poll the monitor (using isCanceled) periodically and abort at their earliest convenience. Operation can however choose to ignore cancelation requests. Based on org.eclipse.core.runtime.IProgressMonitor.

Method Summary

Modifier and Type	Method	Description
void	beginTask(java.lang.String task, int totalWork)	Notifies that the main task is beginning.
void	cancel()	Cancel the running task.
void	done()	Notifies that the work is done; that is, either the main task is completed or the user canceled it.
long	getStartTime()	Get the time when beginTask() has been called.
boolean	isCanceled()	Returns whether cancelation of current operation has been requested.
void	worked(int work)	Notifies that a given number of work unit of the main task has been completed.

Method Detail

beginTask

void beginTask(java.lang.String task,
               int totalWork)

Notifies that the main task is beginning.

Parameters:

task - name

totalWork -

worked

void worked(int work)

Notifies that a given number of work unit of the main task has been completed.

Parameters:

work -

cancel

void cancel()

Cancel the running task.

isCanceled

boolean isCanceled()

Returns whether cancelation of current operation has been requested.

Returns:

true if is canceled

done

void done()

Notifies that the work is done; that is, either the main task is completed or the user canceled it.

getStartTime

long getStartTime()

Get the time when beginTask() has been called.

Returns:

the begin time in milliseconds.