Package org.forgerock.openig.fapi.apiclient.service

Enum Class ApiClientServiceException.ErrorCode

java.lang.Object

java.lang.Enum<ApiClientServiceException.ErrorCode>

org.forgerock.openig.fapi.apiclient.service.ApiClientServiceException.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<ApiClientServiceException.ErrorCode>, Constable

Enclosing class:

ApiClientServiceException

public static enum ApiClientServiceException.ErrorCode
extends Enum<ApiClientServiceException.ErrorCode>

Enumeration of possible error codes for the ApiClientServiceException.

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
DECODE_FAILED	Indicates that we were unable to decode the returned ApiClient data.
DELETED	Indicates that the requested ApiClient has been deleted.
NOT_FOUND	Indicates that the requested ApiClient was not found.
SERVER_ERROR	Indicates that an unexpected error occurred.

Method Summary

Modifier and Type	Method	Description
static ApiClientServiceException.ErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiClientServiceException.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

DELETED

public static final ApiClientServiceException.ErrorCode DELETED

Indicates that the requested ApiClient has been deleted.

NOT_FOUND

public static final ApiClientServiceException.ErrorCode NOT_FOUND

Indicates that the requested ApiClient was not found.

DECODE_FAILED

public static final ApiClientServiceException.ErrorCode DECODE_FAILED

Indicates that we were unable to decode the returned ApiClient data.

SERVER_ERROR

public static final ApiClientServiceException.ErrorCode SERVER_ERROR

Indicates that an unexpected error occurred.

Method Details

values

public static ApiClientServiceException.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 ApiClientServiceException.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