Package uk.ac.manchester.spinnaker.alloc.client

Enum State

java.lang.Object
java.lang.Enum<State>
uk.ac.manchester.spinnaker.alloc.client.State
All Implemented Interfaces:
Serializable, Comparable<State>
public enum State
extends Enum<State>
States that a job might be in.

Jobs start in UNKNOWN, then go immediately to QUEUED, then to POWER before entering READY. Whenever the power status of a job is changed, it goes back into POWER before going back to READY. When a job is destroyed, it enters DESTROYED, possibly indirectly via POWER. Jobs never leave DESTROYED except to cease to exist.

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    DESTROYED
    The job has been destroyed.
    POWER
    The boards allocated to the job are currently being powered on or powered off.
    QUEUED
    The job is waiting in a queue for a suitable machine.
    READY
    The job has been allocated boards and the boards are not currently powering on or powering off.
    UNKNOWN
    The job ID requested was not recognised, or is in the initial state.

  • Method Summary

    Modifier and Type Method Description
    static State valueOf​(String name)
    Returns the enum constant of this type with the specified name.
    static 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final State UNKNOWN
      The job ID requested was not recognised, or is in the initial state.

    • QUEUED

      public static final State QUEUED
      The job is waiting in a queue for a suitable machine.

    • POWER

      public static final State POWER
      The boards allocated to the job are currently being powered on or powered off.

    • READY

      public static final State READY
      The job has been allocated boards and the boards are not currently powering on or powering off.

    • DESTROYED

      public static final State DESTROYED
      The job has been destroyed.

  • Method Details

    • values

      public static 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 State valueOf​(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null