com.baasbox.android

Class RequestToken

java.lang.Object

com.baasbox.android.RequestToken

All Implemented Interfaces:

android.os.Parcelable, java.lang.Comparable<RequestToken>

public final class RequestToken
extends java.lang.Object
implements android.os.Parcelable, java.lang.Comparable<RequestToken>

A handle to an asynchronous request.

Since:

0.7.3

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<RequestToken>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
boolean	abort()
<R> BaasResult<R>	await()
boolean	cancel()
int	compareTo(RequestToken another)
int	describeContents()
boolean	equals(java.lang.Object o)
int	hashCode()
static RequestToken	loadAndResume(android.os.Bundle bundle, java.lang.String name, BaasHandler<?> handler) Loads a request token from the bundle and immediately tries to resume the request with handler
boolean	resume(BaasHandler<?> handler) Resumes a suspended asynchronous request, with the new provided handler
boolean	suspend() Tries to suspend the asynchronous request identified by this token.
boolean	suspendAndSave(android.os.Bundle bundle, java.lang.String name) Suspends a request and immediately save it in a bundle
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static android.os.Parcelable.Creator<RequestToken> CREATOR

Method Detail

loadAndResume

public static RequestToken loadAndResume(android.os.Bundle bundle,
                                         java.lang.String name,
                                         BaasHandler<?> handler)

Loads a request token from the bundle and immediately tries to resume the request with handler

Parameters:

bundle - a non null bundle

name - the key of the saved token

handler - a handler to resume the request with.

Returns:

the token if resumed, null otherwise

resume

public boolean resume(BaasHandler<?> handler)

Resumes a suspended asynchronous request, with the new provided handler

Parameters:

handler - a handler to resume the request with.

Returns:

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(RequestToken another)

Specified by:

compareTo in interface java.lang.Comparable<RequestToken>

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

abort

public boolean abort()

await

public <R> BaasResult<R> await()

cancel

public boolean cancel()

suspendAndSave

public boolean suspendAndSave(android.os.Bundle bundle,
                              java.lang.String name)

Suspends a request and immediately save it in a bundle

Parameters:

bundle - a non null bundle

name - the key to save the token with

Returns:

true if the token was suspended

suspend

public boolean suspend()

Tries to suspend the asynchronous request identified by this token. Suspended requests are executed normally but their associated callback is cleared.

Returns:

true if the attempt was successful