public abstract class ProgressProvider extends Object
This class is intended for use by the currently executing Eclipse application. Plug-ins outside the currently running application should not reference or subclass this class.
IJobManager.setProgressProvider(ProgressProvider)
Constructor and Description |
---|
ProgressProvider() |
Modifier and Type | Method and Description |
---|---|
abstract IProgressMonitor |
createMonitor(Job job)
Provides a new progress monitor instance to be used by the given job.
|
IProgressMonitor |
createMonitor(Job job,
IProgressMonitor group,
int ticks)
Returns a progress monitor that can be used by a running job
to report progress in the context of a progress group.
|
IProgressMonitor |
createProgressGroup()
Returns a progress monitor that can be used to provide
aggregated progress feedback on a set of running jobs.
|
IProgressMonitor |
getDefaultMonitor()
Returns a progress monitor to use when none has been provided
by the client running the job.
|
public abstract IProgressMonitor createMonitor(Job job)
run
method.job
- the job to create a progress monitor fornull
if no progress monitoring
is needed.createProgressGroup()
,
Job.setProgressGroup(IProgressMonitor, int)
public IProgressMonitor createProgressGroup()
IJobManager.createProgressGroup
,
and must obey all rules specified in that contract.
This default implementation returns a new
NullProgressMonitor
Subclasses may override.
IJobManager.createProgressGroup()
public IProgressMonitor createMonitor(Job job, IProgressMonitor group, int ticks)
Job.setProgressGroup
. One of the
two createMonitor
methods will be invoked
prior to each execution of a job, depending on whether a progress
group was specified for the job.
The provided monitor must be a monitor returned by the method
createProgressGroup
. This method is responsible
for asserting this and throwing an appropriate runtime exception
if an invalid monitor is provided.
This default implementation returns a new
SubProgressMonitor
. Subclasses may override.
job
- the job to create a progress monitor forgroup
- the progress monitor group that this job belongs toticks
- the number of ticks of work for the progress monitornull
if no progress monitoring
is needed.IJobManager.createProgressGroup()
,
Job.setProgressGroup(IProgressMonitor, int)
public IProgressMonitor getDefaultMonitor()
This default implementation returns a new
NullProgressMonitor
Subclasses may override.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.