org.finra.herd.tools.common

Enum ToolsCommonConstants.ReturnValue

java.lang.Object

java.lang.Enum<ToolsCommonConstants.ReturnValue>

org.finra.herd.tools.common.ToolsCommonConstants.ReturnValue

All Implemented Interfaces:

Serializable, Comparable<ToolsCommonConstants.ReturnValue>

Enclosing class:

ToolsCommonConstants

public static enum ToolsCommonConstants.ReturnValue
extends Enum<ToolsCommonConstants.ReturnValue>

The list of possible return values for the herd tool applications.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILURE
SUCCESS

Method Summary

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

FAILURE

public static final ToolsCommonConstants.ReturnValue FAILURE

Method Detail

values

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

Returns:

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

valueOf

public static ToolsCommonConstants.ReturnValue 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

getReturnCode

public int getReturnCode()