public abstract class WorkspaceJob extends org.eclipse.core.internal.resources.InternalWorkspaceJob
runInWorkspaceinstead of the usual
After running a method that modifies resources in the workspace, registered listeners receive after-the-fact notification of what just transpired, in the form of a resource change event. This method allows clients to call a number of methods that modify resources and only have resource change event notifications reported at the end of the entire batch. This mechanism is used to avoid unnecessary builds and notifications.
Platform may decide to perform notifications during the operation. The reason for this is that it is possible for multiple threads to be modifying the workspace concurrently. When one thread finishes modifying the workspace, a notification is required to prevent responsiveness problems, even if the other operation has not yet completed.
A WorkspaceJob is the asynchronous equivalent of ICoreRunnable
Note that the workspace is not locked against other threads during the execution of a workspace job. Other threads can be modifying the workspace concurrently with a workspace job. To obtain exclusive access to a portion of the workspace, set the scheduling rule on the job to be a resource scheduling rule. The interface IResourceRuleFactory is used to create a scheduling rule for a particular workspace modification operation.
ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING
|Constructor and Description|
Creates a new workspace job with the specified name.
|Modifier and Type||Method and Description|
Runs the operation, reporting progress to and accepting cancellation requests from the given progress monitor.
addJobChangeListener, belongsTo, cancel, canceling, create, create, createSystem, 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public WorkspaceJob(String name)
name- the name of the job
public abstract IStatus runInWorkspace(IProgressMonitor monitor) throws CoreException
Implementors of this method should check the progress monitor
for cancellation when it is safe and appropriate to do so. The cancellation
request should be propagated to the caller by throwing
monitor- a progress monitor, or
nullif progress reporting and cancellation are not desired
CoreException- if this operation fails.
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.