Package org.refcodes.console

Enum ExitCode

  • All Implemented Interfaces:
    org.refcodes.mixin.StatusCodeAccessor<java.lang.Integer>

    public enum ExitCode
extends java.lang.Enum<ExitCode>
implements org.refcodes.mixin.StatusCodeAccessor<java.lang.Integer>
    Some default exit codes defined for CLI applications.
    Author:
    steiner

    • Nested Class Summary

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

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Integer getStatusCode​()
      Gets the status code.
      static ExitCode valueOf​(java.lang.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

      • SUCCESS

        public static final ExitCode SUCCESS

      • FAIL

        public static final ExitCode FAIL

      • ARGS_ERROR

        public static final ExitCode ARGS_ERROR

      • IO_ERROR

        public static final ExitCode IO_ERROR

    • 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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getStatusCode

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