Package de.espirit.firstspirit.scheduling

Interface ScheduleTaskControl

@ForUseOnly public interface ScheduleTaskControl
Container providing means to control a task.
Since:
5.2.14

  • Method Summary

    Modifier and Type
    Method
    Description
    <A> A
    getAspect(@NotNull ScheduleTaskAspectType<A> type)
    Provides aspects of the underlying task.
    @Nullable String
    getDescription()
    Provides a description of the task.
    int
    getIndex()
    Provides the index of the task with respect to the execution chain.
    @NotNull String
    getName()
    Provides the name of the task.
    @NotNull RunState
    getState()
    Provides the current execution state of the task.
    boolean
    isFinished()
    Indicates the task being done.

  • Method Details

    • getAspect

      @Nullable <A> A getAspect(@NotNull @NotNull ScheduleTaskAspectType<A> type)
      Provides aspects of the underlying task.
      Parameters:
      type - The aspect type.
      Returns:
      The aspect or null, if not supported by the task.
      Since:
      5.2.301

    • getIndex

      int getIndex()
      Provides the index of the task with respect to the execution chain.
      Returns:
      The task's index.
      Since:
      5.2.14

    • getName

      @NotNull @NotNull String getName()
      Provides the name of the task.
      Returns:
      The task's name.
      Since:
      5.2.14

    • getDescription

      @Nullable @Nullable String getDescription()
      Provides a description of the task.
      Returns:
      The task's description.
      Since:
      5.2.14

    • isFinished

      boolean isFinished()
      Indicates the task being done.
      Returns:
      true, if finished.
      Since:
      5.2.14

    • getState

      @NotNull @NotNull RunState getState()
      Provides the current execution state of the task.
      Returns:
      The execution state.
      Since:
      5.2.14