|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.jobs.ProgressProvider
The progress provider supplies the job manager with progress monitors for running jobs. There can only be one progress provider at any given time.
This class is for internal use by the platform-related plug-ins. Clients outside of the base platform should not reference or subclass this class.
IJobManager.setProgressProvider(ProgressProvider)
Constructor Summary | |
---|---|
ProgressProvider()
|
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ProgressProvider()
Method Detail |
public abstract IProgressMonitor createMonitor(Job job)
run
method.
job
- the job to create a progress monitor for
null
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 monitor
null
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.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.