Bug 544456 - createMonitor: change to return SubMonitor
instead of deprecated SubProgressMonitor
Change-Id: I502f4d2886e50705d14fc4a3b5da2cedac6faa1e
Signed-off-by: Karsten Thoms <karsten.thoms@itemis.de>
diff --git a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/runtime/jobs/ProgressProvider.java b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/runtime/jobs/ProgressProvider.java
index 8159a23..a2239ce 100644
--- a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/runtime/jobs/ProgressProvider.java
+++ b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/runtime/jobs/ProgressProvider.java
@@ -43,13 +43,13 @@
public abstract IProgressMonitor createMonitor(Job job);
/**
- * Returns a progress monitor that can be used to provide
- * aggregated progress feedback on a set of running jobs.
- * This method implements <code>IJobManager.createProgressGroup</code>,
- * and must obey all rules specified in that contract.
+ * Returns a progress monitor that can be used to provide aggregated progress
+ * feedback on a set of running jobs. This method implements
+ * <code>IJobManager.createProgressGroup</code>, and must obey all rules
+ * specified in that contract.
* <p>
- * This default implementation returns a new
- * <code>NullProgressMonitor</code> Subclasses may override.
+ * This default implementation returns a new <code>NullProgressMonitor</code>.
+ * Subclasses may override.
*
* @see IJobManager#createProgressGroup()
* @return a progress monitor
@@ -59,31 +59,29 @@
}
/**
- * Returns a progress monitor that can be used by a running job
- * to report progress in the context of a progress group. This method
- * implements <code>Job.setProgressGroup</code>. One of the
- * two <code>createMonitor</code> methods will be invoked
- * prior to each execution of a job, depending on whether a progress
- * group was specified for the job.
+ * Returns a progress monitor that can be used by a running job to report
+ * progress in the context of a progress group. One of the two
+ * <code>createMonitor</code> methods will be invoked prior to each execution of
+ * a job, depending on whether a progress group was specified for the job.
* <p>
* The provided monitor must be a monitor returned by the method
- * <code>createProgressGroup</code>. This method is responsible
- * for asserting this and throwing an appropriate runtime exception
- * if an invalid monitor is provided.
+ * <code>createProgressGroup</code>. This method is responsible for asserting
+ * this and throwing an appropriate runtime exception if an invalid monitor is
+ * provided.
* <p>
- * This default implementation returns a new
- * <code>SubProgressMonitor</code>. Subclasses may override.
+ * This default implementation returns a new <code>SubMonitor</code>. Subclasses
+ * may override.
*
* @see IJobManager#createProgressGroup()
* @see Job#setProgressGroup(IProgressMonitor, int)
- * @param job the job to create a progress monitor for
+ * @param job the job to create a progress monitor for
* @param group the progress monitor group that this job belongs to
* @param ticks the number of ticks of work for the progress monitor
- * @return a progress monitor, or <code>null</code> if no progress monitoring
- * is needed.
+ * @return a progress monitor, or <code>null</code> if no progress monitoring is
+ * needed.
*/
public IProgressMonitor createMonitor(Job job, IProgressMonitor group, int ticks) {
- return new SubProgressMonitor(group, ticks);
+ return SubMonitor.convert(group, ticks);
}
/**
