org.yamj.api.common.exception

Class ApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.yamj.api.common.exception.ApiException

All Implemented Interfaces:

Serializable

public class ApiException
extends Exception

Exception for API Classes to use

Author:

Stuart

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApiException(ApiExceptionType exceptionType, String response) Generate an API exception
ApiException(ApiExceptionType exceptionType, String response, int responseCode, String url) Generate an API exception
ApiException(ApiExceptionType exceptionType, String response, int responseCode, String url, Throwable cause) Generate an API exception
ApiException(ApiExceptionType exceptionType, String response, int responseCode, URL url) Generate an API exception
ApiException(ApiExceptionType exceptionType, String response, int responseCode, URL url, Throwable cause) Generate an API exception
ApiException(ApiExceptionType exceptionType, String response, String url) Generate an API exception
ApiException(ApiExceptionType exceptionType, String response, String url, Throwable cause) Generate an API exception
ApiException(ApiExceptionType exceptionType, String response, URL url) Generate an API exception
ApiException(ApiExceptionType exceptionType, String response, URL url, Throwable cause) Generate an API exception

Method Summary

Methods

Modifier and Type	Method and Description
ApiExceptionType	getExceptionType() The enumerated type of the exception
String	getResponse() The response message associated with the exception
int	getResponseCode() The response code, such as the HTTP status from a web request
String	getUrl() The URL that cause the exception or is associated with it

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response,
            URL url)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

url - The URL that cause the exception or is associated with it

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response,
            int responseCode,
            URL url)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

responseCode - A response code, such as the HTTP status from a web request

url - The URL that cause the exception or is associated with it

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response,
            String url)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

url - The URL that cause the exception or is associated with it

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response,
            int responseCode,
            String url)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

responseCode - A response code, such as the HTTP status from a web request

url - The URL that cause the exception or is associated with it

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response,
            URL url,
            Throwable cause)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

url - The URL that cause the exception or is associated with it

cause - The underlying exception that was the cause of this API Exception

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response,
            int responseCode,
            URL url,
            Throwable cause)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

responseCode - A response code, such as the HTTP status from a web request

url - The URL that cause the exception or is associated with it

cause - The underlying exception that was the cause of this API Exception

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response,
            String url,
            Throwable cause)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

url - The URL that cause the exception or is associated with it

cause - The underlying exception that was the cause of this API Exception

ApiException

public ApiException(ApiExceptionType exceptionType,
            String response,
            int responseCode,
            String url,
            Throwable cause)

Generate an API exception

Parameters:

exceptionType - The type of the exception to throw

response - A response message associated with the exception

responseCode - A response code, such as the HTTP status from a web request

url - The URL that cause the exception or is associated with it

cause - The underlying exception that was the cause of this API Exception

Method Detail

getExceptionType

public ApiExceptionType getExceptionType()

The enumerated type of the exception

Returns:

The exception type

getResponse

public String getResponse()

The response message associated with the exception

Returns:

The response message

getResponseCode

public int getResponseCode()

The response code, such as the HTTP status from a web request

Returns:

The response code

getUrl

public String getUrl()

The URL that cause the exception or is associated with it

Returns:

the URL