Package gov.nist.secauto.metaschema.cli.processor

Enum ExitCode

java.lang.Object

java.lang.Enum<ExitCode>

gov.nist.secauto.metaschema.cli.processor.ExitCode

All Implemented Interfaces:

Serializable, Comparable<ExitCode>

public enum ExitCode
extends Enum<ExitCode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL	The command executed properly, but the operation failed.
INVALID_ARGUMENTS	The provided argument information for a command fails to match argument use requirements.
INVALID_COMMAND	A command was requested by name that doesn't exist or required arguments are missing.
INVALID_TARGET	The target argument was not found or invalid.
IO_ERROR	An error occurred while reading or writing.
OK	The command executed without issue.
PROCESSING_ERROR	Handled errors that occur during command execution.
RUNTIME_ERROR	Unhandled errors that occur during command execution.

Method Summary

Modifier and Type	Method	Description
ExitStatus	exit()	Exit without a message.
ExitStatus	exitMessage()	Exit with the associated message.
ExitStatus	exitMessage(Object... messageArguments)	Exit with the associated message and message arguments.
int	getStatusCode()	Get the related status code for use with System.exit(int).
static ExitCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ExitCode[]	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 ExitCode OK

The command executed without issue.

FAIL

public static final ExitCode FAIL

The command executed properly, but the operation failed.

IO_ERROR

public static final ExitCode IO_ERROR

An error occurred while reading or writing.

INVALID_COMMAND

public static final ExitCode INVALID_COMMAND

A command was requested by name that doesn't exist or required arguments are missing.

INVALID_TARGET

public static final ExitCode INVALID_TARGET

The target argument was not found or invalid.

PROCESSING_ERROR

public static final ExitCode PROCESSING_ERROR

Handled errors that occur during command execution.

RUNTIME_ERROR

public static final ExitCode RUNTIME_ERROR

Unhandled errors that occur during command execution.

INVALID_ARGUMENTS

public static final ExitCode INVALID_ARGUMENTS

The provided argument information for a command fails to match argument use requirements.

Method Detail

values

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

Returns:

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

valueOf

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

getStatusCode

public int getStatusCode()

Get the related status code for use with System.exit(int).

Returns:

the statusCode

exit

@NonNull
public ExitStatus exit()

Exit without a message.

Returns:

the exit status

exitMessage

@NonNull
public ExitStatus exitMessage()

Exit with the associated message.

Returns:

the exit status

exitMessage

@NonNull
public ExitStatus exitMessage(@NonNull
                              Object... messageArguments)

Exit with the associated message and message arguments.

Parameters:

messageArguments - any message parameters

Returns:

the exit status