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

Field Summary

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

Constructors

Constructor	Description
UIJob(String name)	Create a new instance of the receiver with the supplied name.
UIJob(Display jobDisplay, String name)	Create a new instance of the receiver with the supplied Display.

Method Summary

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.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

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

UIJob

public UIJob(Display jobDisplay,
             String name)

Create a new instance of the receiver with the supplied Display.

Parameters:

jobDisplay - the display

name - the job name

See Also:

Job

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 class Job

Parameters:

monitor - the monitor to be used for reporting progress and responding to cancelation. The monitor is never null

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 never null

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.