com.box.androidsdk.content

Class BoxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.box.androidsdk.content.BoxException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxException.CacheImplementationNotFound, BoxException.CacheResultUnavilable, BoxException.MaxAttemptsExceeded, BoxException.RefreshFailure

public class BoxException
extends java.lang.Exception

Thrown to indicate that an error occurred while communicating with the Box API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxException.CacheImplementationNotFound Exception class that indicates a cache implementation was not set in BoxConfig.setCache(BoxCache)
static class	BoxException.CacheResultUnavilable Exception class that signifies a result was not found in the cache
static class	BoxException.ErrorType
static class	BoxException.MaxAttemptsExceeded An exception that indicates the RealTimeServerConnection has exceeded the recommended number of retries.
static class	BoxException.RateLimitAttemptsExceeded
static class	BoxException.RefreshFailure

Constructor Summary

Constructors

Constructor and Description
BoxException(java.lang.String message) Constructs a BoxAPIException with a specified message.
BoxException(java.lang.String message, BoxHttpResponse response) Constructs a BoxAPIException with details about the server's response.
BoxException(java.lang.String message, int responseCode, java.lang.String response, java.lang.Throwable cause) Constructs a BoxAPIException that wraps another underlying exception with details about the server's response.
BoxException(java.lang.String message, java.lang.Throwable cause) Constructs a BoxAPIException that wraps another underlying exception.

Method Summary

Modifier and Type	Method and Description
BoxError	getAsBoxError() Gets the server response as a BoxError.
BoxException.ErrorType	getErrorType()
java.lang.String	getResponse() Gets the body of the response returned by the server when this exception was thrown.
int	getResponseCode() Gets the response code returned by the server when this exception was thrown.

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

BoxException

public BoxException(java.lang.String message)

Constructs a BoxAPIException with a specified message.

Parameters:

message - a message explaining why the exception occurred.

BoxException

public BoxException(java.lang.String message,
                    BoxHttpResponse response)

Constructs a BoxAPIException with details about the server's response.

Parameters:

message - a message explaining why the exception occurred.

response - the response body returned by the Box server.

BoxException

public BoxException(java.lang.String message,
                    java.lang.Throwable cause)

Constructs a BoxAPIException that wraps another underlying exception.

Parameters:

message - a message explaining why the exception occurred.

cause - an underlying exception.

BoxException

public BoxException(java.lang.String message,
                    int responseCode,
                    java.lang.String response,
                    java.lang.Throwable cause)

Constructs a BoxAPIException that wraps another underlying exception with details about the server's response.

Parameters:

message - a message explaining why the exception occurred.

responseCode - the response code returned by the Box server.

response - the response body returned by the Box server.

cause - an underlying exception.

Method Detail

getResponseCode

public int getResponseCode()

Gets the response code returned by the server when this exception was thrown.

Returns:

the response code returned by the server.

getResponse

public java.lang.String getResponse()

Gets the body of the response returned by the server when this exception was thrown.

Returns:

the body of the response returned by the server.

getAsBoxError

public BoxError getAsBoxError()

Gets the server response as a BoxError.

Returns:

the response as a BoxError, or null if the response cannot be converted.

getErrorType

public BoxException.ErrorType getErrorType()

Returns:

a known error type that corresponds to a given response and code.