|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.PlatformObject
org.eclipse.core.internal.jobs.InternalJob
org.eclipse.core.runtime.jobs.Job
org.eclipse.equinox.p2.operations.ProvisioningJob
public abstract class ProvisioningJob
Abstract class representing provisioning jobs. Provisioning jobs can be run in the background by scheduling them, or they can be run by a client in a modal context. An additional progress monitor can be set into the job for progress reporting.
Field Summary | |
---|---|
static int |
RESTART_NONE
Constant which indicates that the job does not require a restart upon completion. |
static int |
RESTART_ONLY
Constant which indicates that the job requires the user to restart in order to pick up the changes performed by the job. |
static int |
RESTART_OR_APPLY
Constant which indicates that the job requires the user to either restart or apply the configuration changes in order to pick up the changes performed by the job. |
Fields inherited from class org.eclipse.core.runtime.jobs.Job |
---|
ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING |
Fields inherited from class org.eclipse.core.internal.jobs.InternalJob |
---|
manager |
Constructor Summary | |
---|---|
ProvisioningJob(String name,
ProvisioningSession session)
Create a provisioning job with the given name that uses the provided provisioning session for retrieving any services needed. |
Method Summary | |
---|---|
protected IStatus |
getErrorStatus(String message,
ProvisionException e)
Return an error status that can be used to report the specified exception. |
int |
getRestartPolicy()
Return the restart policy that is appropriate for this job. |
protected ProvisioningSession |
getSession()
Return the provisioning session that is used by the receiver when retrieving necessary provisioning services. |
IStatus |
run(IProgressMonitor monitor)
Executes this job. |
abstract IStatus |
runModal(IProgressMonitor monitor)
Perform the specific work involved in running this job in the current thread. |
void |
setAdditionalProgressMonitor(IProgressMonitor monitor)
|
Methods inherited from class org.eclipse.core.runtime.jobs.Job |
---|
addJobChangeListener, belongsTo, cancel, canceling, done, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, removeJobChangeListener, schedule, schedule, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, toString, wakeUp, wakeUp, yieldRule |
Methods inherited from class org.eclipse.core.internal.jobs.InternalJob |
---|
compareTo |
Methods inherited from class org.eclipse.core.runtime.PlatformObject |
---|
getAdapter |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Field Detail |
---|
public static final int RESTART_NONE
public static final int RESTART_OR_APPLY
public static final int RESTART_ONLY
Constructor Detail |
---|
public ProvisioningJob(String name, ProvisioningSession session)
name
- the name of the jobsession
- the session providing the servicesMethod Detail |
---|
protected ProvisioningSession getSession()
ProvisioningSession
public void setAdditionalProgressMonitor(IProgressMonitor monitor)
public final IStatus run(IProgressMonitor monitor)
run
in class Job
monitor
- the monitor to be used for reporting progress and
responding to cancelation. The monitor is never null
null
Job.run(org.eclipse.core.runtime.IProgressMonitor)
public abstract IStatus runModal(IProgressMonitor monitor)
monitor
- the progress monitor to use for the operation
public int getRestartPolicy()
RESTART_NONE
,
RESTART_ONLY
,
RESTART_OR_APPLY
protected IStatus getErrorStatus(String message, ProvisionException e)
message
- the message that should be used in the statuse
- the exception to be reported
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.