eu.ehri.project.commands

Enum CmdEntryPoint.RetCode

java.lang.Object

java.lang.Enum<CmdEntryPoint.RetCode>

eu.ehri.project.commands.CmdEntryPoint.RetCode

All Implemented Interfaces:

Serializable, Comparable<CmdEntryPoint.RetCode>

Enclosing class:

CmdEntryPoint

public static enum CmdEntryPoint.RetCode
extends Enum<CmdEntryPoint.RetCode>

Default return codes for shell tools.

0 means 'OK', 1 'bad arguments', 2 'bad data', 3 'bad permissions'

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_ARGS
BAD_DATA
BAD_PERMS
OK

Method Summary

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

OK

public static final CmdEntryPoint.RetCode OK

BAD_ARGS

public static final CmdEntryPoint.RetCode BAD_ARGS

BAD_DATA

public static final CmdEntryPoint.RetCode BAD_DATA

BAD_PERMS

public static final CmdEntryPoint.RetCode BAD_PERMS

Method Detail

values

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

Returns:

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

valueOf

public static CmdEntryPoint.RetCode 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

getCode

public int getCode()