Package org.opentcs.data.peripherals

Enum PeripheralJob.State

java.lang.Object
java.lang.Enum<PeripheralJob.State>
org.opentcs.data.peripherals.PeripheralJob.State
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PeripheralJob.State>, java.lang.constant.Constable
Enclosing class:
PeripheralJob
public static enum PeripheralJob.State
extends java.lang.Enum<PeripheralJob.State>
Defines the various states a peripheral job may be in.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    BEING_PROCESSED
    Indicates a peripheral job is currently being processed by a peripheral.
    FAILED
    Indicates execution of a peripheral job has failed / was aborted / was never started.
    FINISHED
    Indicates a peripheral job has been completed successfully.
    TO_BE_PROCESSED
    Indicates a peripheral job is still waiting to be processed.

  • Method Summary

    Modifier and Type Method Description
    boolean isFinalState()
    Checks if this state is a final state for a peripheral job.
    static PeripheralJob.State valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static PeripheralJob.State[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

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

    • valueOf

      public static PeripheralJob.State valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.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.