Package org.opentcs.data.peripherals
Enum Class PeripheralJob.State
- All Implemented Interfaces:
Serializable
,Comparable<PeripheralJob.State>
,Constable
- Enclosing class:
PeripheralJob
Defines the various states a peripheral job may be in.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionIndicates a peripheral job is currently being processed by a peripheral.Indicates execution of a peripheral job has failed / was aborted / was never started.Indicates a peripheral job has been completed successfully.Indicates a peripheral job is still waiting to be processed. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if this state is a final state for a peripheral job.static PeripheralJob.State
Returns the enum constant of this class with the specified name.static PeripheralJob.State[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
TO_BE_PROCESSED
Indicates a peripheral job is still waiting to be processed. -
BEING_PROCESSED
Indicates a peripheral job is currently being processed by a peripheral. -
FINISHED
Indicates a peripheral job has been completed successfully. -
FAILED
Indicates execution of a peripheral job has failed / was aborted / was never started.
-
-
Method Details
-
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
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 nameNullPointerException
- 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.
-