com.braintreepayments.api.exceptions

Class ErrorWithResponse

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.braintreepayments.api.exceptions.ErrorWithResponse

All Implemented Interfaces:

android.os.Parcelable, java.io.Serializable

public class ErrorWithResponse
extends java.lang.Exception
implements android.os.Parcelable

Error container returned when the Braintree server returns a 422 Unprocessible Entity. A 422 occurs when a request is properly formed, but the server was unable to take the requested action due to bad user data. ErrorWithResponse parses the server's error response and exposes the errors.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<ErrorWithResponse>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	ErrorWithResponse(int statusCode, java.lang.String jsonString)
protected	ErrorWithResponse(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
BraintreeError	errorFor(java.lang.String field) Method to extract an error for an individual field, e.g.
static ErrorWithResponse	fromGraphQLJson(java.lang.String json)
static ErrorWithResponse	fromJson(java.lang.String json)
java.lang.String	getErrorResponse()
java.util.List<BraintreeError>	getFieldErrors()
java.lang.String	getMessage()
int	getStatusCode()
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<ErrorWithResponse> CREATOR

Constructor Detail

ErrorWithResponse

public ErrorWithResponse(int statusCode,
                         java.lang.String jsonString)

ErrorWithResponse

protected ErrorWithResponse(android.os.Parcel in)

Method Detail

fromJson

public static ErrorWithResponse fromJson(java.lang.String json)
                                  throws org.json.JSONException

Throws:

org.json.JSONException

fromGraphQLJson

public static ErrorWithResponse fromGraphQLJson(java.lang.String json)

getStatusCode

public int getStatusCode()

Returns:

HTTP status code from the Braintree gateway.

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

Returns:

Human readable top level summary of the error.

getErrorResponse

public java.lang.String getErrorResponse()

Returns:

The full error response as a String.

getFieldErrors

public java.util.List<BraintreeError> getFieldErrors()

Returns:

All the field errors.

errorFor

public BraintreeError errorFor(java.lang.String field)

Method to extract an error for an individual field, e.g. creditCard, customer, etc.

Parameters:

field - Name of the field desired, expected to be in camelCase.

Returns:

BraintreeError for the field searched, or null if not found.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable