public interface IRunnableWithProgress
IRunnableWithProgressinterface should be implemented by any class whose instances are intended to be executed as a long-running operation. Long-running operations are typically presented at the UI via a modal dialog showing a progress indicator and a Cancel button. The class must define a
runmethod that takes a progress monitor. The
runmethod is usually not invoked directly, but rather by passing the
runmethod of an
IRunnableContext, which provides the UI for the progress monitor and Cancel button.
void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException
runmethod, which supplies the progress monitor. A request to cancel the operation should be honored and acknowledged by throwing
monitor- the progress monitor to use to display progress and receive requests for cancelation
InvocationTargetException- if the run method must propagate a checked exception, it should wrap it inside an
InvocationTargetException; runtime exceptions are automatically wrapped in an
InvocationTargetExceptionby the calling context
InterruptedException- if the operation detects a request to cancel, using
IProgressMonitor.isCanceled(), it should exit by throwing
IRunnableContext.run(boolean, boolean, org.eclipse.jface.operation.IRunnableWithProgress)
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.