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>
An enumeration of supported exit code values.

  • Enum Constant Details

    • 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 Details

    • values

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