Enum Job.Status

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Job.Status>
    Enclosing class:
    Job

    public static enum Job.Status
    extends java.lang.Enum<Job.Status>
    Signifies the status of a Job.
    Since:
    100.0.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FAILED
      The job has failed in which case an error is available using Job.getError().
      NOT_STARTED
      The job has not been started yet.
      PAUSED
      The job has been paused.
      STARTED
      The job has started.
      SUCCEEDED
      The job has completed successfully in which case the result is available using Job.getResult().
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Job.Status valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Job.Status[] 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 Detail

      • NOT_STARTED

        public static final Job.Status NOT_STARTED
        The job has not been started yet.
        Since:
        100.0.0
      • STARTED

        public static final Job.Status STARTED
        The job has started.
        Since:
        100.0.0
      • PAUSED

        public static final Job.Status PAUSED
        The job has been paused.
        Since:
        100.0.0
      • SUCCEEDED

        public static final Job.Status SUCCEEDED
        The job has completed successfully in which case the result is available using Job.getResult().
        Since:
        100.0.0
      • FAILED

        public static final Job.Status FAILED
        The job has failed in which case an error is available using Job.getError().
        Since:
        100.0.0
    • Method Detail

      • values

        public static Job.Status[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Job.Status c : Job.Status.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Job.Status 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