Package com.thanlinardos.spring_enterprise_library.error.errorcodes

Enum Class ErrorCode

java.lang.Object

java.lang.Enum<ErrorCode>

com.thanlinardos.spring_enterprise_library.error.errorcodes.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<ErrorCode>, Constable

public enum ErrorCode
extends Enum<ErrorCode>

Enumeration of error codes used in the application. Each error code has a name, numeric code, and severity level.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMPTY_LIST	Error code indicating that a list was expected to be non-empty but was empty.
ILLEGAL_ARGUMENT	Error code indicating an illegal argument was provided.
LIST_NOT_SAME_SIZE	Error code indicating that two lists were expected to be of the same size but were not.
MORE_THAN_ONE_FOUND	Error code indicating that more than one result was found when only one was expected.
NON_EMPTY_LIST	Error code indicating that a list was expected to be empty but was not.
NONE_FOUND	Error code indicating that no results were found when at least one was expected.
UNEXPECTED_ERROR	Error code indicating an unexpected error occurred.

Method Summary

Modifier and Type	Method	Description
CoreException	createCoreException(String message)	Creates a CoreException with this error code and the given message.
CoreException	createCoreException(String message, Object[] args)	Creates a CoreException with this error code, the given message and arguments for message formatting.
CoreException	createCoreException(String message, Throwable e)	Creates a CoreException with this error code, the given message and cause.
CoreException	createCoreException(String message, Throwable e, Object[] args)	Creates a CoreException with this error code, the given message, a cause and arguments for message formatting.
static ErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ErrorCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ILLEGAL_ARGUMENT

public static final ErrorCode ILLEGAL_ARGUMENT

Error code indicating an illegal argument was provided.

NONE_FOUND

public static final ErrorCode NONE_FOUND

Error code indicating that no results were found when at least one was expected.

MORE_THAN_ONE_FOUND

public static final ErrorCode MORE_THAN_ONE_FOUND

Error code indicating that more than one result was found when only one was expected.

EMPTY_LIST

public static final ErrorCode EMPTY_LIST

Error code indicating that a list was expected to be non-empty but was empty.

NON_EMPTY_LIST

public static final ErrorCode NON_EMPTY_LIST

Error code indicating that a list was expected to be empty but was not.

LIST_NOT_SAME_SIZE

public static final ErrorCode LIST_NOT_SAME_SIZE

Error code indicating that two lists were expected to be of the same size but were not.

UNEXPECTED_ERROR

public static final ErrorCode UNEXPECTED_ERROR

Error code indicating an unexpected error occurred.

Method Details

values

public static ErrorCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ErrorCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

createCoreException

public CoreException createCoreException(String message)

Creates a CoreException with this error code and the given message.

Parameters:

message - the error message

Returns:

a CoreException instance

createCoreException

public CoreException createCoreException(String message,
 Throwable e,
 Object[] args)

Creates a CoreException with this error code, the given message, a cause and arguments for message formatting.

Parameters:

message - the error message

e - the cause of the exception

args - optional arguments for message formatting.

Returns:

a CoreException instance

createCoreException

public CoreException createCoreException(String message,
 Object[] args)

Creates a CoreException with this error code, the given message and arguments for message formatting.

Parameters:

message - the error message

args - optional arguments for message formatting.

Returns:

a CoreException instance

createCoreException

public CoreException createCoreException(String message,
 Throwable e)

Creates a CoreException with this error code, the given message and cause.

Parameters:

message - the error message

e - the cause of the exception

Returns:

a CoreException instance