Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSergey Prigogin2015-09-28 21:39:04 +0000
committerStefan Xenos2015-10-13 16:11:39 +0000
commitcfd2db785b81221deeaaa8e3850a89e5415f33c6 (patch)
tree98ca213763bcf881ed2ef9420c36225ba2396807 /bundles/org.eclipse.equinox.common
parentd17844220c08f1f54a0133fde8a55e16d76c179c (diff)
downloadrt.equinox.bundles-cfd2db785b81221deeaaa8e3850a89e5415f33c6.tar.gz
rt.equinox.bundles-cfd2db785b81221deeaaa8e3850a89e5415f33c6.tar.xz
rt.equinox.bundles-cfd2db785b81221deeaaa8e3850a89e5415f33c6.zip
Bug 474264: Need an easier to use variant of Job.create method
Fix for comment 33: Avoid breaking API changes for IWorkspaceRunnable#run(..) Change-Id: I5639125c06c580744dbb4e5325d700a0c1c2baf3 Signed-off-by: Sergey Prigogin <eclipse.sprigogin@gmail.com>
Diffstat (limited to 'bundles/org.eclipse.equinox.common')
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ICoreRunnable.java18
1 files changed, 10 insertions, 8 deletions
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ICoreRunnable.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ICoreRunnable.java
index 3813ca4e..8e5cd9b5 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ICoreRunnable.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ICoreRunnable.java
@@ -22,16 +22,18 @@ public interface ICoreRunnable {
* The provided monitor can be used to report progress and respond to
* cancellation. If the progress monitor has been canceled, the runnable
* should finish its execution at the earliest convenience and throw
- * a {@link CoreException} with a status of severity {@link IStatus#CANCEL}.
- * The singleton cancel status {@link Status#CANCEL_STATUS} can be used for
- * this purpose. The monitor is only valid for the duration of the invocation
- * of this method.
+ * an {@link OperationCanceledException}. A {@link CoreException} with a status
+ * of severity {@link IStatus#CANCEL} has the same effect as
+ * an {@link OperationCanceledException}.
*
- * @param monitor the monitor to be used for reporting progress and
- * responding to cancellation. The monitor is never {@code null}.
- * It is the caller's responsibility to call {@link IProgressMonitor#done()}
- * after this method returns or throws an exception.
+ * @param monitor a progress monitor, or {@code null} if progress reporting and
+ * cancellation are not desired. The monitor is only valid for the duration
+ * of the invocation of this method. The receiver is not responsible for
+ * calling {@link IProgressMonitor#done()} on the given monitor, and
+ * the caller must not rely on {@link IProgressMonitor#done()} having been
+ * called by the receiver.
* @exception CoreException if this operation fails.
+ * @exception OperationCanceledException if the operation is canceled.
*/
public void run(IProgressMonitor monitor) throws CoreException;
}

Back to the top