io.ably.lib.types

Class AblyException

java.lang.Object

java.lang.Throwable

java.lang.Exception

io.ably.lib.types.AblyException

All Implemented Interfaces:

java.io.Serializable

public class AblyException
extends java.lang.Exception

An exception type encapsulating an Ably error code

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ErrorInfo	errorInfo

Constructor Summary

Constructors

Constructor and Description
AblyException(ErrorInfo reason) Constructor for use where there is an ErrorInfo available
AblyException(java.lang.String reason, int statusCode, int code) Constructor for use where there is a specific reason code available
AblyException(java.lang.Throwable cause) Constructor for use where the exception wasn't anticipated at a lower level

Method Summary

Modifier and Type	Method and Description
static AblyException	fromError(ErrorInfo error) Get an exception from a response body with error details
static AblyException	fromIOException(java.io.IOException ioe) Get an exception from an IOException occurring locally
static AblyException	fromJSON(byte[] jsonBytes) Get an exception from a response body with error details as byte[]
static AblyException	fromJSON(java.lang.String jsonText) Get an exception from a response body with error details
static AblyException	fromResponseStatus(java.lang.String statusLine, int statusCode) Get an exception from an error response that does not contain a response body with error details
static AblyException	fromThrowable(java.lang.Throwable t) Get an exception from a throwable occurring locally

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

Field Detail

errorInfo

public ErrorInfo errorInfo

Constructor Detail

AblyException

public AblyException(java.lang.Throwable cause)

Constructor for use where the exception wasn't anticipated at a lower level

AblyException

public AblyException(ErrorInfo reason)

Constructor for use where there is an ErrorInfo available

AblyException

public AblyException(java.lang.String reason,
                     int statusCode,
                     int code)

Constructor for use where there is a specific reason code available

Method Detail

fromJSON

public static AblyException fromJSON(java.lang.String jsonText)
                              throws AblyException

Get an exception from a response body with error details

Parameters:

jsonText -

Returns:

Throws:

AblyException

fromError

public static AblyException fromError(ErrorInfo error)
                               throws AblyException

Get an exception from a response body with error details

Parameters:

jsonText -

Returns:

Throws:

AblyException

fromJSON

public static AblyException fromJSON(byte[] jsonBytes)

Get an exception from a response body with error details as byte[]

Parameters:

jsonBytes -

Returns:

fromIOException

public static AblyException fromIOException(java.io.IOException ioe)

Get an exception from an IOException occurring locally

Parameters:

ioe -

Returns:

fromResponseStatus

public static AblyException fromResponseStatus(java.lang.String statusLine,
                                               int statusCode)

Get an exception from an error response that does not contain a response body with error details

Parameters:

statusLine -

statusCode -

Returns:

fromThrowable

public static AblyException fromThrowable(java.lang.Throwable t)

Get an exception from a throwable occurring locally

Parameters:

t -

Returns: