Package com.xinapse.platform

Enum Class ExitStatus

java.lang.Object
java.lang.Enum<ExitStatus>
com.xinapse.platform.ExitStatus
All Implemented Interfaces:
Serializable, Comparable<ExitStatus>, Constable
public enum ExitStatus extends Enum<ExitStatus>
Exit status codes on program termination.

  • Enum Constant Details

    • NORMAL

      public static final ExitStatus NORMAL
      Exit status for normal program termination (0).

    • HELP_REQUESTED

      public static final ExitStatus HELP_REQUESTED
      Exit status for termination when help has been requested (1).

    • CANCELLED_BY_USER

      public static final ExitStatus CANCELLED_BY_USER
      Exit status when the program has been cancelled by the user (2).

    • UNRECOGNIZED_ARGUMENT

      public static final ExitStatus UNRECOGNIZED_ARGUMENT
      Exit status when a program argument is not recognised for this program (10).

    • INVALID_ARGUMENT

      public static final ExitStatus INVALID_ARGUMENT
      Exit status for when a program argument is invalid (11).

    • INVALID_PROPERTY_VALUE

      public static final ExitStatus INVALID_PROPERTY_VALUE
      Exit status for when a system property used by the program has an invalid value (12).

    • NOT_ENOUGH_ARGUMENTS

      public static final ExitStatus NOT_ENOUGH_ARGUMENTS
      Exit status when not enough program arguments are given (13).

    • TOO_MANY_ARGUMENTS

      public static final ExitStatus TOO_MANY_ARGUMENTS
      Exit status when too many program arguments are given (14).

    • CONFLICTING_ARGUMENTS

      public static final ExitStatus CONFLICTING_ARGUMENTS
      Exit status when program arguments conflict with each other (15).

    • MISSING_ARGUMENT

      public static final ExitStatus MISSING_ARGUMENT
      Exit status when a compulsory argument is missing (16).

    • NON_SPECIFIC_ERROR

      public static final ExitStatus NON_SPECIFIC_ERROR
      Exit status indicating a non-specific error (20).

    • IMAGE_OPEN_ERROR

      public static final ExitStatus IMAGE_OPEN_ERROR
      Exit status when an image cannot be opened (21).

    • INVALID_IMAGE_ERROR

      public static final ExitStatus INVALID_IMAGE_ERROR
      Exit status when an image is invalid (22).

    • IMAGE_CREATE_ERROR

      public static final ExitStatus IMAGE_CREATE_ERROR
      Exit status when an output image cannot be created (23).

    • IMAGE_WRITE_ERROR

      public static final ExitStatus IMAGE_WRITE_ERROR
      Exit status when an output image cannot be written (24).

    • ROI_ERROR

      public static final ExitStatus ROI_ERROR
      Exit status when a ROI-related error occurs (25).

    • NUMERICAL_ERROR

      public static final ExitStatus NUMERICAL_ERROR
      Exit status when a numerical algorithm fails (30).

    • DATA_FORMAT_ERROR

      public static final ExitStatus DATA_FORMAT_ERROR
      Exit status when data is in the wrong format (31).

    • IO_ERROR

      public static final ExitStatus IO_ERROR
      Exit status when a general input/output error occurs (50).

    • DICOM_FORMAT_ERROR

      public static final ExitStatus DICOM_FORMAT_ERROR
      Exit status when a badly-formatted DICOM object is encountered (50).

    • INSUFFICIENT_RESOURCES

      public static final ExitStatus INSUFFICIENT_RESOURCES
      Exit status when there are insufficient resources available to perform the operation (80).

    • INTERNAL_ERROR

      public static final ExitStatus INTERNAL_ERROR
      Exit status when an internal (programming) error has occurred (90).

    • OUT_OF_MEMORY

      public static final ExitStatus OUT_OF_MEMORY
      Exit status when program runs out of memory (91).

    • UNIT_TEST_FAIL

      public static final ExitStatus UNIT_TEST_FAIL
      Exit status for a unit test fails (92).

    • NO_LICENSE

      public static final ExitStatus NO_LICENSE
      Exit status when a valid license cannot be found (100).

    • DISCLAIMER_NOT_ACKNOWLEDGED

      public static final ExitStatus DISCLAIMER_NOT_ACKNOWLEDGED
      Exit status when the clinical use disclaimer has not been acknowledged by the user (101).

    • INVALID_JVM

      public static final ExitStatus INVALID_JVM
      Exit status when the java virtual machine used is not suitable for running this release of the software (102).

    • NO_JAVA3D

      public static final ExitStatus NO_JAVA3D
      Exit status when the java3d is not installed or not installed correctly (103).

    • UNKNOWN_HOST

      public static final ExitStatus UNKNOWN_HOST
      Exit status when there is an attempt to access an unknown host (110).

    • DATABASE_ERROR

      public static final ExitStatus DATABASE_ERROR
      Exit status when there is an error accessing a database (120).

  • Method Details

    • values

      public static ExitStatus[] 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

      public static ExitStatus valueOf(String name)
      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 name
      NullPointerException - if the argument is null

    • getStatus

      public int getStatus()
      Returns the integer exit status code for this ExitStatus.
      Returns:
      the exit status code.