Enum Class ApiErrorReason

java.lang.Object

java.lang.Enum<ApiErrorReason>

com.bluebell.greenhouse.platform.enums.api.ApiErrorReason

All Implemented Interfaces:

GenericEnum<ApiErrorReason>, Serializable, Comparable<ApiErrorReason>, Constable

public enum ApiErrorReason
extends Enum<ApiErrorReason>
implements GenericEnum<ApiErrorReason>

Enumeration of the various reasons an api error is created. This class somewhat relates to the reasonPhase in an HttpServletRequest.

Version:

3.0.6

Author:

Stephen Prizio

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BAD_REQUEST
FORBIDDEN
INTERNAL_SERVER_ERROR
NOT_FOUND
SERVICE_UNAVAILABLE
UNAUTHORIZED

Method Summary

Modifier and Type	Method	Description
static ApiErrorReason	fromLabel(String label)	Computes an ApiErrorReason from a label.
static ApiErrorReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiErrorReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface GenericEnum

getCode, getEnum, getLabel

Enum Constant Details

UNAUTHORIZED

public static final ApiErrorReason UNAUTHORIZED

FORBIDDEN

public static final ApiErrorReason FORBIDDEN

BAD_REQUEST

public static final ApiErrorReason BAD_REQUEST

NOT_FOUND

public static final ApiErrorReason NOT_FOUND

INTERNAL_SERVER_ERROR

public static final ApiErrorReason INTERNAL_SERVER_ERROR

SERVICE_UNAVAILABLE

public static final ApiErrorReason SERVICE_UNAVAILABLE

Method Details

values

public static ApiErrorReason[] 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 ApiErrorReason 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

fromLabel

public static ApiErrorReason fromLabel(String label)

Computes an ApiErrorReason from a label.

Parameters:

label - label

Returns:

ApiErrorReason