Module org.refcodes.cli

Package org.refcodes.cli

Enum ExitCode

java.lang.Object

java.lang.Enum<ExitCode>

org.refcodes.cli.ExitCode

All Implemented Interfaces:

Serializable, Comparable<Integer>, 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 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
ARGS_ERROR
FAIL
IO_ERROR
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 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(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 Integer getStatusCode()

Gets the status code.

Specified by:

getStatusCode in interface org.refcodes.mixin.StatusCodeAccessor<Integer>

Returns:

the status code