Package org.eclipse.ui.progress
Class UIJob
- java.lang.Object
-
- org.eclipse.core.runtime.PlatformObject
-
- org.eclipse.core.internal.jobs.InternalJob
-
- org.eclipse.core.runtime.jobs.Job
-
- org.eclipse.ui.progress.UIJob
-
- All Implemented Interfaces:
Comparable
,IAdaptable
- Direct Known Subclasses:
WorkbenchJob
public abstract class UIJob extends Job
The UIJob is a Job that runs within the UI Thread via an asyncExec.- Since:
- 3.0
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static IStatus
errorStatus(Throwable exception)
Convenience method to return a status for an exception.Display
getDisplay()
Returns the display for use by the receiver when running in an asyncExec.IStatus
run(IProgressMonitor monitor)
Note: this message is marked final.abstract IStatus
runInUIThread(IProgressMonitor monitor)
Run the job in the UI Thread.void
setDisplay(Display runDisplay)
Sets the display to execute the asyncExec in.-
Methods inherited from class org.eclipse.core.runtime.jobs.Job
addJobChangeListener, belongsTo, cancel, canceling, create, create, createSystem, createSystem, done, getJobGroup, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, join, removeJobChangeListener, schedule, schedule, setJobGroup, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, toString, wakeUp, wakeUp, yieldRule
-
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
-
-
-
-
Constructor Detail
-
UIJob
public UIJob(String name)
Create a new instance of the receiver with the supplied name. The display used will be the one from the workbench if this is available. UIJobs with this constructor will determine their display at runtime.- Parameters:
name
- the job name
-
-
Method Detail
-
errorStatus
public static IStatus errorStatus(Throwable exception)
Convenience method to return a status for an exception.- Parameters:
exception
- the thrown exception- Returns:
- IStatus an error status built from the exception
- See Also:
Job
-
run
public final IStatus run(IProgressMonitor monitor)
Note: this message is marked final. Implementors should use runInUIThread() instead.- Specified by:
run
in classJob
- Parameters:
monitor
- the monitor to be used for reporting progress and responding to cancelation. The monitor is nevernull
- Returns:
- resulting status of the run. The result must not be
null
- See Also:
Job.run(org.eclipse.core.runtime.IProgressMonitor)
-
runInUIThread
public abstract IStatus runInUIThread(IProgressMonitor monitor)
Run the job in the UI Thread.- Parameters:
monitor
- the monitor to be used for reporting progress and responding to cancellation. The monitor is nevernull
- Returns:
- resulting status of the run. The result must not be
null
-
setDisplay
public void setDisplay(Display runDisplay)
Sets the display to execute the asyncExec in. Generally this is not' used if there is a valid display available via PlatformUI.isWorkbenchRunning().- Parameters:
runDisplay
- Display- See Also:
getDisplay()
,PlatformUI.isWorkbenchRunning()
-
getDisplay
public Display getDisplay()
Returns the display for use by the receiver when running in an asyncExec. If it is not set then the display set in the workbench is used. If the display is null the job will not be run.- Returns:
- Display or
null
.
-
-