|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRemoteProgressMonitor
Remote API Wrapper for the org.eclipse.core.runtime.IProgressMonitor
(Online documentation)
Original documentation:
The IRemoteProgressMonitor
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).
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 |
setStatus(int severity,
int code,
java.lang.String message,
java.lang.Throwable t)
Method to return a status information to Eclipse after done() has
been called. |
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 |
---|
static final int UNKNOWN
Method Detail |
---|
void beginTask(java.lang.String name, int totalWork) throws RemoteEclipseAPIException
name
- the name (or description) of the main tasktotalWork
- 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.
RemoteEclipseAPIException
void done() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void internalWorked(double work) throws RemoteEclipseAPIException
work
- the amount of work done
RemoteEclipseAPIException
boolean isCanceled() throws RemoteEclipseAPIException
true
if cancellation has been requested,
and false
otherwise
RemoteEclipseAPIException
setCanceled(boolean)
void setCanceled(boolean value) throws RemoteEclipseAPIException
value
- true
indicates that cancelation has
been requested (but not necessarily acknowledged);
false
clears this flag
RemoteEclipseAPIException
isCanceled()
void setTaskName(java.lang.String name) throws RemoteEclipseAPIException
name
- the name (or description) of the main task
RemoteEclipseAPIException
beginTask(java.lang.String, int)
void subTask(java.lang.String name) throws RemoteEclipseAPIException
name
- the name (or description) of the subtask
RemoteEclipseAPIException
void worked(int work) throws RemoteEclipseAPIException
work
- a non-negative number of work units just completed
RemoteEclipseAPIException
void setStatus(int severity, int code, java.lang.String message, java.lang.Throwable t) throws RemoteEclipseAPIException
done()
has
been called. See org.eclipse.core.runtime.IStatus
for details on
the parameters
severity
- code
- message
- t
-
RemoteEclipseAPIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |