org.openhubframework.openhub.modules

Enum ErrorEnum

java.lang.Object

java.lang.Enum<ErrorEnum>

org.openhubframework.openhub.modules.ErrorEnum

All Implemented Interfaces:

Serializable, Comparable<ErrorEnum>, ErrorExtEnum

public enum ErrorEnum
extends Enum<ErrorEnum>
implements ErrorExtEnum

Catalog of custom error codes.

Author:

Petr Juza

Method Summary

Methods

Modifier and Type	Method and Description
String	getErrDesc() Gets error description.
String	getErrorCode() Gets name of this enum.
static ErrorEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorEnum[]	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

Method Detail

values

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

Returns:

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

valueOf

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

getErrorCode

public String getErrorCode()

Description copied from interface: ErrorExtEnum

Gets name of this enum.

Specified by:

getErrorCode in interface ErrorExtEnum

Returns:

error enum name

getErrDesc

public String getErrDesc()

Description copied from interface: ErrorExtEnum

Gets error description.

Specified by:

getErrDesc in interface ErrorExtEnum

Returns:

error description