Package org.eclipse.e4.ui.dialogs.filteredtree

Class BasicUIJob

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.core.internal.jobs.InternalJob

org.eclipse.core.runtime.jobs.Job

org.eclipse.e4.ui.dialogs.filteredtree.BasicUIJob

All Implemented Interfaces:

Comparable<org.eclipse.core.internal.jobs.InternalJob>, IAdaptable

public abstract class BasicUIJob
extends Job

Merge of UIJob and WokbenchJob minus tracking whether the workbench is running - do not use for long running jobs!

Since:

1.2

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
BasicUIJob(String name, Display display)	Create a new instance of the receiver with the supplied name.

Method Summary

Modifier and Type	Method	Description
Display	getDisplay()	Returns the display for use by the receiver when running in an asyncExec.
final IStatus	run(IProgressMonitor monitor)	Executes this job.
abstract IStatus	runInUIThread(IProgressMonitor monitor)	Run the job in the UI Thread.

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 Details

BasicUIJob

public BasicUIJob(String name,
 Display display)

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 Details

run

public final IStatus run(IProgressMonitor monitor)

Description copied from class: Job

Executes this job. Returns the result of the execution.

The provided monitor can be used to report progress and respond to cancellation. If the progress monitor has been canceled, the job should finish its execution at the earliest convenience and return a result status of severity IStatus.CANCEL. The singleton cancel status Status.CANCEL_STATUS can be used for this purpose. The monitor is only valid for the duration of the invocation of this method.

This method must not be called directly by clients. Clients should call schedule, which will in turn cause this method to be called.

Jobs can optionally finish their execution asynchronously (in another thread) by returning a result status of Job.ASYNC_FINISH. Jobs that finish asynchronously must specify the execution thread by calling setThread, and must indicate when they are finished by calling the method done.

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:

• Note: this message is marked final. Implementors should use runInUIThread() instead.

runInUIThread

public abstract IStatus runInUIThread(IProgressMonitor monitor)

Run the job in the UI Thread.

Returns:

IStatus

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.