Enum Class PeripheralJob.State

java.lang.Object
java.lang.Enum<PeripheralJob.State>
org.opentcs.data.peripherals.PeripheralJob.State
All Implemented Interfaces:
Serializable, Comparable<PeripheralJob.State>, Constable
Enclosing class:
PeripheralJob

public static enum PeripheralJob.State extends Enum<PeripheralJob.State>
Defines the various states a peripheral job may be in.
  • Enum Constant Details

    • TO_BE_PROCESSED

      public static final PeripheralJob.State TO_BE_PROCESSED
      Indicates a peripheral job is still waiting to be processed.
    • BEING_PROCESSED

      public static final PeripheralJob.State BEING_PROCESSED
      Indicates a peripheral job is currently being processed by a peripheral.
    • FINISHED

      public static final PeripheralJob.State FINISHED
      Indicates a peripheral job has been completed successfully.
    • FAILED

      public static final PeripheralJob.State FAILED
      Indicates execution of a peripheral job has failed / was aborted / was never started.
  • Method Details

    • values

      public static PeripheralJob.State[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PeripheralJob.State valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • isFinalState

      public boolean isFinalState()
      Checks if this state is a final state for a peripheral job.
      Returns:
      true if, and only if, this state is a final state for a peripheral job - i.e. FINISHED or FAILED.