public interface IRunnableWithProgress
IRunnableWithProgress
interface 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 run
method that takes a progress monitor.Modifier and Type | Method and Description |
---|---|
void |
run(IProgressMonitor monitor)
Runs this operation.
|
void run(IProgressMonitor monitor) throws InvocationTargetException, OperationCanceledException
IRunnableContext
's run
method,
which supplies the progress monitor.
A request to cancel the operation should be honored and acknowledged
by throwing InterruptedException
.monitor
- the progress monitor to use to display progress and receive
requests for cancelationOperationCanceledException
- if the operation detects a request to cancel,
using IProgressMonitor.isCanceled()
, it should exit by throwing
OperationCanceledException
InvocationTargetException
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.