org.xmcda

Enum ProgramExecutionResult.Status

java.lang.Object

java.lang.Enum<ProgramExecutionResult.Status>

org.xmcda.ProgramExecutionResult.Status

All Implemented Interfaces:

Serializable, Comparable<ProgramExecutionResult.Status>

Enclosing class:

ProgramExecutionResult

public static enum ProgramExecutionResult.Status
extends Enum<ProgramExecutionResult.Status>

This enumerates the statuses that a program execution result can have. A program can use this to determine its own return status code. Both status OK and WARNING means that a program's execution is successful, even if a WARNING status tells that the user may have to check the outputs and/or the warning messages issued by the program.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Status ERROR means that at least an error has been signaled with ProgramExecutionResult.addError(String).
OK Status OK means that neither ProgramExecutionResult.addWarning(String) nor ProgramExecutionResult.addError(String) have been called
TERMINATED Status TERMINATED is a special one in that it is not set by any method but forceStatus(Status.TERMINATED)
WARNING Status WARNING means that at least a warning has been signaled with ProgramExecutionResult.addWarning(String), but that no errors have been signaled.

Method Summary

Modifier and Type	Method and Description
int	exitStatus() Returns the exit status corresponding to this status.
static ProgramExecutionResult.Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProgramExecutionResult.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

OK

public static final ProgramExecutionResult.Status OK

Status OK means that neither ProgramExecutionResult.addWarning(String) nor ProgramExecutionResult.addError(String) have been called

WARNING

public static final ProgramExecutionResult.Status WARNING

Status WARNING means that at least a warning has been signaled with ProgramExecutionResult.addWarning(String), but that no errors have been signaled.

ERROR

public static final ProgramExecutionResult.Status ERROR

Status ERROR means that at least an error has been signaled with ProgramExecutionResult.addError(String).

TERMINATED

public static final ProgramExecutionResult.Status TERMINATED

Status TERMINATED is a special one in that it is not set by any method but forceStatus(Status.TERMINATED)

Method Detail

values

public static ProgramExecutionResult.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 (ProgramExecutionResult.Status c : ProgramExecutionResult.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 ProgramExecutionResult.Status 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

exitStatus

public int exitStatus()

Returns the exit status corresponding to this status. A program typically use this for returning its own exit status.

• OK and status represents a successful execution, hence the return code is 0 (zero),
• ERROR returns 1,
• TERMINATED return 2.

Returns:

0 for OK and WARNING, 1 for ERROR and 2 for TERMINATED.