Class ObservableWorkspaceJob

  • All Implemented Interfaces:
    java.lang.Comparable, org.eclipse.core.runtime.IAdaptable
    Direct Known Subclasses:
    ReasoningProgressObserver

    public abstract class ObservableWorkspaceJob
    extends org.eclipse.core.resources.WorkspaceJob
    A job that makes an atomic modification to the workspace.
    Author:
    Holger Eichelberger
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private EclipseProgressObserver observer  
      • 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
      ObservableWorkspaceJob​(java.lang.String name)
      Sole constructor for this class.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract org.eclipse.core.runtime.IStatus doJob()
      The method which should be performed.
      EclipseProgressObserver getObserver()
      Returns the observer of this WorkspaceJob.
      org.eclipse.core.runtime.IStatus runInWorkspace​(org.eclipse.core.runtime.IProgressMonitor monitor)  
      • Methods inherited from class org.eclipse.core.internal.resources.InternalWorkspaceJob

        run
      • 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
      • Methods inherited from interface org.eclipse.core.runtime.IAdaptable

        getAdapter
    • Constructor Detail

      • ObservableWorkspaceJob

        public ObservableWorkspaceJob​(java.lang.String name)
        Sole constructor for this class.
        Parameters:
        name - The name of this WorkspaceJob
    • Method Detail

      • runInWorkspace

        public org.eclipse.core.runtime.IStatus runInWorkspace​(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                        throws org.eclipse.core.runtime.CoreException
        Specified by:
        runInWorkspace in class org.eclipse.core.resources.WorkspaceJob
        Throws:
        org.eclipse.core.runtime.CoreException
      • doJob

        protected abstract org.eclipse.core.runtime.IStatus doJob()
                                                           throws org.eclipse.core.runtime.CoreException
        The method which should be performed.
        Returns:
        A status object represents the outcome of an operation.
        Throws:
        org.eclipse.core.runtime.CoreException - Can be thrown in case of an eclipse based failure.
      • getObserver

        public EclipseProgressObserver getObserver()
        Returns the observer of this WorkspaceJob.
        Returns:
        The observer of this WorkspaceJob