Enum Class ExitCode

java.lang.Object
java.lang.Enum<ExitCode>
de.gustavblass.nginx.ipguard4j.cli.ExitCode
All Implemented Interfaces:
Serializable, Comparable<ExitCode>, Constable
public enum ExitCode extends Enum<ExitCode>

The exit status indicated by the program when it terminates. Each exit code has a specific meaning.

  • Enum Constant Details

    • SUCCESS

      public static final ExitCode SUCCESS
      The program terminated successfully.

    • INVALID_COMMAND_LINE_ARGUMENTS

      public static final ExitCode INVALID_COMMAND_LINE_ARGUMENTS
      The given command-line parameters were invalid.

    • INVALID_LOGGING_LEVEL

      public static final ExitCode INVALID_LOGGING_LEVEL
      The given logging Level was invalid.

    • INVALID_CONFIGURATION

      public static final ExitCode INVALID_CONFIGURATION
      The given Configuration file was invalid.

    • CONFIGURATION_FILE_DOES_NOT_EXIST

      public static final ExitCode CONFIGURATION_FILE_DOES_NOT_EXIST
      The given configuration file does not exist at the specified path.

    • CONFIGURATION_FILE_IS_NOT_A_FILE

      public static final ExitCode CONFIGURATION_FILE_IS_NOT_A_FILE
      The given configuration file is not a regular file (e.g. it is a directory).

    • CONFIGURATION_FILE_DOES_NOT_MATCH_EXPECTED_FORMAT

      public static final ExitCode CONFIGURATION_FILE_DOES_NOT_MATCH_EXPECTED_FORMAT
      The given Configuration does not match the expected format.

    • IO_ERROR

      public static final ExitCode IO_ERROR
      An input/output error occurred.

    • IO_ERROR_WHILE_READING_CONFIGURATION_FILE

      public static final ExitCode IO_ERROR_WHILE_READING_CONFIGURATION_FILE
      An input/output error occurred while reading the configuration file.

    • IO_ERROR_WHILE_FETCHING_IP_LISTS

      public static final ExitCode IO_ERROR_WHILE_FETCHING_IP_LISTS
      An input/output error occurred while downloading the IP list(s).

    • IO_ERROR_WHILE_WRITING_IP_LISTS

      public static final ExitCode IO_ERROR_WHILE_WRITING_IP_LISTS
      An input/output error occurred while writing the IP list(s) to the target file(s).

    • IO_ERROR_WHILE_READING_RESOURCE_FILE

      public static final ExitCode IO_ERROR_WHILE_READING_RESOURCE_FILE
      An input/output error occurred while reading a File in the application's resources folder.

    • INTERRUPTED

      public static final ExitCode INTERRUPTED
      An InterruptedException occurred.

    • INTERNAL_ERROR

      public static final ExitCode INTERNAL_ERROR
      An unexpected error occurred that does not fall into any of the other categories.

  • Field Details

    • code

      public final @Range(from=0L,to=2147483647L) int code

  • Constructor Details

    • ExitCode

      private ExitCode(int code)

  • Method Details

    • values

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