co.codewizards.cloudstore.core.progress

Interface ProgressMonitor

All Known Implementing Classes:

LoggerProgressMonitor, NullProgressMonitor, ProgressMonitorDelegator, SubProgressMonitor

public interface ProgressMonitor

Interface to report the progress of an activity. This is used like org.eclipse.core.runtime.IProgressMonitor.

Author:

Alexander Bieber

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTask(String name, int totalWork) Notifies that the main task is beginning.
void	done() Notifies that the work is done; that is, either the main task is completed or the user canceled it.
void	internalWorked(double worked) Internal method to handle scaling correctly.
boolean	isCanceled() Returns whether cancelation of current operation has been requested.
void	setCanceled(boolean canceled) Sets the cancel state to the given value.
void	setTaskName(String name) Sets the task name to the given value.
void	subTask(String name) Notifies that a subtask of the main task is beginning.
void	worked(int work) Notifies that a given number of work unit of the main task has been completed.

Method Detail

beginTask

void beginTask(String name,
             int totalWork)

Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.

Parameters:

name - the name (or description) of the main task

totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.

done

void done()

Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).

isCanceled

boolean isCanceled()

Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

If this is true, the long-running operation should throw an OperationCanceledException.

Returns:

true if cancellation has been requested, and false otherwise

See Also:

setCanceled(boolean)

setCanceled

void setCanceled(boolean canceled)

Sets the cancel state to the given value.

Parameters:

canceled - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag

See Also:

isCanceled()

internalWorked

void internalWorked(double worked)

Internal method to handle scaling correctly. This method must not be called by a client. Clients should always use the method worked(int).

Note: EclipseRCP is strange!

Parameters:

worked - the amount of work done

setTaskName

void setTaskName(String name)

Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.

Parameters:

name - the name (or description) of the main task

See Also:

beginTask(java.lang.String, int)

subTask

void subTask(String name)

Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.

Parameters:

name - the name (or description) of the subtask

worked

void worked(int work)

Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.

Parameters:

work - the number of work units just completed