Package com.carrotsearch.console.launcher

Enum ExitCodes

java.lang.Object

java.lang.Enum<ExitCodes>

com.carrotsearch.console.launcher.ExitCodes

All Implemented Interfaces:

ExitCode, java.io.Serializable, java.lang.Comparable<ExitCodes>

public enum ExitCodes
extends java.lang.Enum<ExitCodes>
implements ExitCode

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR_INTERNAL	An internal error.
ERROR_INVALID_ARGUMENTS	Invalid input arguments or their combination.
ERROR_UNKNOWN	Unknown error cause.
SUCCESS	The command was successful.

Method Summary

Modifier and Type	Method	Description
int	processReturnValue()
static ExitCodes	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ExitCodes[]	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 ExitCodes SUCCESS

The command was successful.

ERROR_UNKNOWN

public static final ExitCodes ERROR_UNKNOWN

Unknown error cause.

ERROR_INVALID_ARGUMENTS

public static final ExitCodes ERROR_INVALID_ARGUMENTS

Invalid input arguments or their combination.

ERROR_INTERNAL

public static final ExitCodes ERROR_INTERNAL

An internal error.

Method Detail

values

public static ExitCodes[] 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 (ExitCodes c : ExitCodes.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExitCodes 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

processReturnValue

public int processReturnValue()

Specified by:

processReturnValue in interface ExitCode