IProgressMonitor

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> core >> [ runtime overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.core.runtime.IProgressMonitor

SOURCE |

Download org.eclipse.core.runtime.IProgressMonitor

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.runtime
Interface IProgressMonitor

All Known Subinterfaces:: IProgressMonitorWithBlocking

All Known Implementing Classes:: NullProgressMonitor, ProgressMonitorWrapper

public interface IProgressMonitor

The IProgressMonitor 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.

Since notification is synchronous with the activity itself, the listener should provide a fast and robust implementation. If the handling of notifications would involve blocking operations, or operations which might throw uncaught exceptions, the notifications should be queued, and the actual processing deferred (or perhaps delegated to a separate thread).

Clients may implement this interface.

Field Summary

static int UNKNOWN
          Constant indicating an unknown amount of work.

Method Summary

void beginTask(java.lang.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 work)
          Internal method to handle scaling correctly.

boolean isCanceled()
          Returns whether cancelation of current operation has been requested.

void setCanceled(boolean value)
          Sets the cancel state to the given value.

void setTaskName(java.lang.String name)
          Sets the task name to the given value.

void subTask(java.lang.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.

Field Detail

UNKNOWN

public static final int UNKNOWN

Constant indicating an unknown amount of work.

See Also:: Constant Field Values

Method Detail

beginTask

public void beginTask(java.lang.String name,
                      int totalWork)

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

done

public 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).

internalWorked

public void internalWorked(double work)

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

isCanceled

public boolean isCanceled()

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

setCanceled

public void setCanceled(boolean value)

Sets the cancel state to the given value.

setTaskName

public void setTaskName(java.lang.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.

subTask

public void subTask(java.lang.String name)

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

worked

public 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.