com.xinapse.platform
Enum ExitStatus

java.lang.Object
  java.lang.Enum<ExitStatus>
      com.xinapse.platform.ExitStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ExitStatus>

public enum ExitStatus
extends java.lang.Enum<ExitStatus>

Exit status codes on program termination.

Enum Constant Summary

CANCELLED_BY_USER
Exit status when the program has been cancelled by the user (2).

CONFLICTING_ARGUMENTS
Exit status when program arguments conflict with each other (15).

DICOM_FORMAT_ERROR
Exit status when a badly-formatted DICOM object is encountered (40).

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

HELP_REQUESTED
Exit status for termination when help has been requested (1).

IMAGE_CREATE_ERROR
Exit status when an output image cannot be created (23).

IMAGE_OPEN_ERROR
Exit status when an image cannot be opened (21).

IMAGE_WRITE_ERROR
Exit status when an output image cannot be written (24).

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

INTERNAL_ERROR
Exit status when an internal (programming) error has occurred (90).

INVALID_ARGUMENT
Exit status for when a program argument is invalid (11).

INVALID_IMAGE_ERROR
Exit status when an image is invalid (22).

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

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

IO_ERROR
Exit status when a general input/output error occurs (50).

MISSING_ARGUMENT
Exit status when a compulsory argument is missing (16).

NO_JAVA3D
Exit status when the java3d is not installed or not installed correctly (103).

NO_LICENSE
Exit status when a valid license cannot be found (100).

NON_SPECIFIC_ERROR
Exit status indicating a non-specific error (20).

NORMAL
Exit status for normal program termination (0).

NOT_ENOUGH_ARGUMENTS
Exit status when not enough program arguments are given (13).

NUMERICAL_ERROR
Exit status when a numerical algorithm fails (30).

OUT_OF_MEMORY
Exit status when program runs out of memory (91).

ROI_ERROR
Exit status when a ROI-related error occurs (25).

TOO_MANY_ARGUMENTS
Exit status when too many program arguments are given (14).

UNIT_TEST_FAIL
Exit status for a unit test fails (92).

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

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

Method Summary

int	getStatus() Returns the integer exit status code for this ExitStatus.
static ExitStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ExitStatus[]	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

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).

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 (40).

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).

Method Detail

values

public static ExitStatus[] 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 (ExitStatus c : ExitStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

getStatus

public int getStatus()

Returns the integer exit status code for this ExitStatus.

Returns:

the exit status code.