org.yamj.api.common.exception

Enum ApiExceptionType

java.lang.Object

java.lang.Enum<ApiExceptionType>

org.yamj.api.common.exception.ApiExceptionType

All Implemented Interfaces:

Serializable, Comparable<ApiExceptionType>

public enum ApiExceptionType
extends Enum<ApiExceptionType>

Enumeration for the possible errors returned by the API

Author:

Stuart.Boston

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTH_FAILURE Auth error
CONNECTION_ERROR Error connecting to the service
HTTP_404_ERROR Page not found
HTTP_503_ERROR Service Unavailable, usually temporary
HTTP_CLIENT_MISSING HTTP client is missing
ID_NOT_FOUND The ID was not found
INVALID_IMAGE Image was invalid
INVALID_URL URL is invalid
MAPPING_FAILED Mapping failed from target to internal objects
UNKNOWN_CAUSE Unknown error occurred

Method Summary

Methods

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

UNKNOWN_CAUSE

public static final ApiExceptionType UNKNOWN_CAUSE

Unknown error occurred

INVALID_URL

public static final ApiExceptionType INVALID_URL

URL is invalid

ID_NOT_FOUND

public static final ApiExceptionType ID_NOT_FOUND

The ID was not found

MAPPING_FAILED

public static final ApiExceptionType MAPPING_FAILED

Mapping failed from target to internal objects

CONNECTION_ERROR

public static final ApiExceptionType CONNECTION_ERROR

Error connecting to the service

INVALID_IMAGE

public static final ApiExceptionType INVALID_IMAGE

Image was invalid

AUTH_FAILURE

public static final ApiExceptionType AUTH_FAILURE

Auth error

HTTP_404_ERROR

public static final ApiExceptionType HTTP_404_ERROR

Page not found

HTTP_503_ERROR

public static final ApiExceptionType HTTP_503_ERROR

Service Unavailable, usually temporary

HTTP_CLIENT_MISSING

public static final ApiExceptionType HTTP_CLIENT_MISSING

HTTP client is missing

Method Detail

values

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

Returns:

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

valueOf

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