Package org.aspectj.org.eclipse.jdt.internal.core.search.processing

Interface IJob

All Known Implementing Classes:
AddJrtToIndex, BinaryContainer, IndexAllProject, IndexBinaryFolder, IndexRequest, PatternSearchJob, SaveIndex, SubTypeSearchJob
public interface IJob

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static int
    CancelIfNotReady
     
    static boolean
    COMPLETE
     
    static boolean
    FAILED
     
    static int
    ForceImmediate
     
    static int
    WaitUntilReady
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    belongsTo​(String jobFamily)
    Answer true if the job belongs to a given family (tag)
    void
    cancel()
    Asks this job to cancel its execution.
    void
    ensureReadyToRun()
    Ensures that this job is ready to run.
    boolean
    execute​(org.eclipse.core.runtime.IProgressMonitor progress)
    Execute the current job, answer whether it was successful.
    String
    getJobFamily()
    Returns this job's family
    default boolean
    waitNeeded()
    Answers if we need some sleep after index write operations.

  • Field Details

  • Method Details

    • belongsTo

      boolean belongsTo​(String jobFamily)
      Answer true if the job belongs to a given family (tag)

    • cancel

      void cancel()
      Asks this job to cancel its execution. The cancellation can take an undertermined amount of time.

    • ensureReadyToRun

      void ensureReadyToRun()
      Ensures that this job is ready to run.

    • execute

      boolean execute​(org.eclipse.core.runtime.IProgressMonitor progress)
      Execute the current job, answer whether it was successful.

    • getJobFamily

      String getJobFamily()
      Returns this job's family

    • waitNeeded

      default boolean waitNeeded()
      Answers if we need some sleep after index write operations. Default implementation returns false.
      Returns:
      true if the job manager should sleep a bit after this job is done to avoid IO tasks overloading OS (which could cause UI freezes etc).