Package be.uclouvain.orthanc

Enum JobStopReason

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<JobStopReason>
    public enum JobStopReason
extends java.lang.Enum<JobStopReason>
    Explains why the job should stop and release the resources it has allocated. This is especially important to disambiguate between the "paused" condition and the "final" conditions (success, failure, or canceled).

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CANCELED
      The job was canceled, and might be resubmitted later
      FAILURE
      The job has failed, and might be resubmitted later
      PAUSED
      The job was paused, and will be resumed later
      SUCCESS
      The job has succeeded

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected static JobStopReason getInstance​(int value)
      Return the enumeration value that corresponds to an integer value of interest.
      int getValue()
      Get the integer value corresponding to this enumeration value.
      static JobStopReason valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static JobStopReason[] 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

      • SUCCESS

        public static final JobStopReason SUCCESS
        The job has succeeded

      • PAUSED

        public static final JobStopReason PAUSED
        The job was paused, and will be resumed later

      • FAILURE

        public static final JobStopReason FAILURE
        The job has failed, and might be resubmitted later

      • CANCELED

        public static final JobStopReason CANCELED
        The job was canceled, and might be resubmitted later

    • Method Detail

      • values

        public static JobStopReason[] 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 (JobStopReason c : JobStopReason.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static JobStopReason 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

      • getInstance

        protected static JobStopReason getInstance​(int value)
        Return the enumeration value that corresponds to an integer value of interest.
        Parameters:
        value - The integer value.
        Returns:
        The enumeration value.

      • getValue

        public int getValue()
        Get the integer value corresponding to this enumeration value.
        Returns:
        The integer value.