com.squareup.square.exceptions

Class ApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.squareup.square.exceptions.ApiException

All Implemented Interfaces:

Serializable

public class ApiException
extends Exception

This is the base class for all exceptions that represent an error response from the server.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApiException(String reason) Initialization constructor.
ApiException(String reason, HttpContext context) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Object	getData() Returns data about the steps that completed successfully before an error was raised.
List<Error>	getErrors() Getter for the list of errors.
HttpContext	getHttpContext() The HTTP response body from the API request.
int	getResponseCode() The HTTP response code from the API request.

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(String reason)

Initialization constructor.

Parameters:

reason - The reason for throwing exception

ApiException

public ApiException(String reason,
                    HttpContext context)

Initialization constructor.

Parameters:

reason - The reason for throwing exception

context - The http context of the API exception

Method Detail

getResponseCode

public int getResponseCode()

The HTTP response code from the API request.

Returns:

Returns the response code for ApiException

getHttpContext

public HttpContext getHttpContext()

The HTTP response body from the API request.

Returns:

Returns the object of HttpContext for ApiException

getData

public Object getData()

Returns data about the steps that completed successfully before an error was raised. This field is currently only populated for the PaymentsApi.createPayment endpoint.

Returns:

Response from the API call.

getErrors

public List<Error> getErrors()

Getter for the list of errors.

Returns:

A list of errors