Module org.refcodes.data
Package org.refcodes.data

Enum Class ExitCode

java.lang.Object
java.lang.Enum<ExitCode>
org.refcodes.data.ExitCode
All Implemented Interfaces:
Serializable, Comparable<ExitCode>, Constable, org.refcodes.mixin.StatusCodeAccessor<Integer>
public enum ExitCode extends Enum<ExitCode> implements org.refcodes.mixin.StatusCodeAccessor<Integer>
Some default exit codes defined for CLI applications.
Author:
steiner

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface org.refcodes.mixin.StatusCodeAccessor

    org.refcodes.mixin.StatusCodeAccessor.StatusCodeBuilder<SC extends Object,B extends org.refcodes.mixin.StatusCodeAccessor.StatusCodeBuilder<SC,B>>, org.refcodes.mixin.StatusCodeAccessor.StatusCodeMutator<SC extends Object>, org.refcodes.mixin.StatusCodeAccessor.StatusCodeProperty<SC extends Object>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CANNOT_EXECUTE
    Command invoked cannot execute, e.g. permission problem.
    CATCHALL
     
    CONTROL_C
    Script terminated by Control-C Ctl-C Control-C
    MISUSE
    Missing keyword or command, or permission problem.
    NOT_FOUND
    Possible problem with $PATH or a typo.
    SUCCESS
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getStatusCode()
    Gets the status code.
    static ExitCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ExitCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • SUCCESS

      public static final ExitCode SUCCESS

    • CATCHALL

      public static final ExitCode CATCHALL

    • MISUSE

      public static final ExitCode MISUSE
      Missing keyword or command, or permission problem.

    • CANNOT_EXECUTE

      public static final ExitCode CANNOT_EXECUTE
      Command invoked cannot execute, e.g. permission problem.

    • NOT_FOUND

      public static final ExitCode NOT_FOUND
      Possible problem with $PATH or a typo.

    • CONTROL_C

      public static final ExitCode CONTROL_C
      Script terminated by Control-C Ctl-C Control-C

  • 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

    • getStatusCode

      public Integer getStatusCode()
      Gets the status code.
      Specified by:
      getStatusCode in interface org.refcodes.mixin.StatusCodeAccessor<Integer>
      Returns:
      the status code