kaaes.spotify.webapi.android

Class SpotifyError

java.lang.Object

java.lang.Throwable

java.lang.Exception

kaaes.spotify.webapi.android.SpotifyError

All Implemented Interfaces:

Serializable

public class SpotifyError
extends Exception

This object wraps error responses from the Web API and provides access to details returned by the request that are usually more descriptive than default Retrofit error messages.

To use with asynchronous requests pass SpotifyCallback instead of Callback when making the request:

spotify.getMySavedTracks(new SpotifyCallback<Pager<SavedTrack>>() {
     public void success(Pager<SavedTrack> savedTrackPager, Response response) {
         // handle successful response
     }

     public void failure(SpotifyError error) {
         // handle error
     }
 });
 

To use with synchronous requests:

try {
     Pager<SavedTrack> mySavedTracks = spotify.getMySavedTracks();
 } catch (RetrofitError error) {
     SpotifyError spotifyError = SpotifyError.fromRetrofitError(error);
 }
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpotifyError(retrofit.RetrofitError retrofitError)
SpotifyError(retrofit.RetrofitError retrofitError, ErrorDetails errorDetails, String message)

Method Summary

Methods

Modifier and Type	Method and Description
static SpotifyError	fromRetrofitError(retrofit.RetrofitError error)
ErrorDetails	getErrorDetails()
retrofit.RetrofitError	getRetrofitError()
boolean	hasErrorDetails()

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

SpotifyError

public SpotifyError(retrofit.RetrofitError retrofitError,
            ErrorDetails errorDetails,
            String message)

SpotifyError

public SpotifyError(retrofit.RetrofitError retrofitError)

Method Detail

fromRetrofitError

public static SpotifyError fromRetrofitError(retrofit.RetrofitError error)

getRetrofitError

public retrofit.RetrofitError getRetrofitError()

Returns:

the original RetrofitError that was returned for this request.

hasErrorDetails

public boolean hasErrorDetails()

Returns:

true if there are ErrorDetails associated with this error. False otherwise.

getErrorDetails

public ErrorDetails getErrorDetails()

Returns:

Details returned from the Web API associated with this error if present.