to top

Since: API Level 1

public abstract class

AsyncQueryHandler

extends Handler

java.lang.Object
↳	android.os.Handler
	↳	android.content.AsyncQueryHandler

Class Overview

A helper class to help make handling asynchronous ContentResolver queries easier.

Summary

Nested Classes
class	AsyncQueryHandler.WorkerArgs
class	AsyncQueryHandler.WorkerHandler

Public Constructors
	AsyncQueryHandler(ContentResolver cr)

Public Methods
final void	cancelOperation(int token) Attempts to cancel operation that has not already started.
void	handleMessage(Message msg) Subclasses must implement this to receive messages.
final void	startDelete(int token, Object cookie, Uri uri, String selection, String[] selectionArgs) This method begins an asynchronous delete.
final void	startInsert(int token, Object cookie, Uri uri, ContentValues initialValues) This method begins an asynchronous insert.
void	startQuery(int token, Object cookie, Uri uri, String[] projection, String selection, String[] selectionArgs, String orderBy) This method begins an asynchronous query.
final void	startUpdate(int token, Object cookie, Uri uri, ContentValues values, String selection, String[] selectionArgs) This method begins an asynchronous update.

Protected Methods
Handler	createHandler(Looper looper)
void	onDeleteComplete(int token, Object cookie, int result) Called when an asynchronous delete is completed.
void	onInsertComplete(int token, Object cookie, Uri uri) Called when an asynchronous insert is completed.
void	onQueryComplete(int token, Object cookie, Cursor cursor) Called when an asynchronous query is completed.
void	onUpdateComplete(int token, Object cookie, int result) Called when an asynchronous update is completed.

[Expand]

Inherited Methods

From class android.os.Handler

void	dispatchMessage(Message msg) Handle system messages here.
final void	dump(Printer pw, String prefix)
final Looper	getLooper()
String	getMessageName(Message message) Returns a string representing the name of the specified message.
void	handleMessage(Message msg) Subclasses must implement this to receive messages.
final boolean	hasMessages(int what, Object object) Check if there are any pending posts of messages with code 'what' and whose obj is 'object' in the message queue.
final boolean	hasMessages(int what) Check if there are any pending posts of messages with code 'what' in the message queue.
final Message	obtainMessage(int what, int arg1, int arg2) Same as `obtainMessage()`, except that it also sets the what, arg1 and arg2 members of the returned Message.
final Message	obtainMessage() Returns a new `Message` from the global message pool.
final Message	obtainMessage(int what, int arg1, int arg2, Object obj) Same as `obtainMessage()`, except that it also sets the what, obj, arg1,and arg2 values on the returned Message.
final Message	obtainMessage(int what) Same as `obtainMessage()`, except that it also sets the what member of the returned Message.
final Message	obtainMessage(int what, Object obj) Same as `obtainMessage()`, except that it also sets the what and obj members of the returned Message.
final boolean	post(Runnable r) Causes the Runnable r to be added to the message queue.
final boolean	postAtFrontOfQueue(Runnable r) Posts a message to an object that implements Runnable.
final boolean	postAtTime(Runnable r, Object token, long uptimeMillis) Causes the Runnable r to be added to the message queue, to be run at a specific time given by `uptimeMillis`.
final boolean	postAtTime(Runnable r, long uptimeMillis) Causes the Runnable r to be added to the message queue, to be run at a specific time given by `uptimeMillis`.
final boolean	postDelayed(Runnable r, long delayMillis) Causes the Runnable r to be added to the message queue, to be run after the specified amount of time elapses.
final void	removeCallbacks(Runnable r) Remove any pending posts of Runnable r that are in the message queue.
final void	removeCallbacks(Runnable r, Object token) Remove any pending posts of Runnable `r` with Object `token` that are in the message queue.
final void	removeCallbacksAndMessages(Object token) Remove any pending posts of callbacks and sent messages whose `obj` is `token`.
final void	removeMessages(int what) Remove any pending posts of messages with code 'what' that are in the message queue.
final void	removeMessages(int what, Object object) Remove any pending posts of messages with code 'what' and whose obj is 'object' that are in the message queue.
final boolean	sendEmptyMessage(int what) Sends a Message containing only the what value.
final boolean	sendEmptyMessageAtTime(int what, long uptimeMillis) Sends a Message containing only the what value, to be delivered at a specific time.
final boolean	sendEmptyMessageDelayed(int what, long delayMillis) Sends a Message containing only the what value, to be delivered after the specified amount of time elapses.
final boolean	sendMessage(Message msg) Pushes a message onto the end of the message queue after all pending messages before the current time.
final boolean	sendMessageAtFrontOfQueue(Message msg) Enqueue a message at the front of the message queue, to be processed on the next iteration of the message loop.
boolean	sendMessageAtTime(Message msg, long uptimeMillis) Enqueue a message into the message queue after all pending messages before the absolute time (in milliseconds) `uptimeMillis`.
final boolean	sendMessageDelayed(Message msg, long delayMillis) Enqueue a message into the message queue after all pending messages before (current time + delayMillis).
String	toString() Returns a string containing a concise, human-readable description of this object.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public AsyncQueryHandler (ContentResolver cr)

Since: API Level 1

Public Methods

public final void cancelOperation (int token)

Since: API Level 1

Attempts to cancel operation that has not already started. Note that there is no guarantee that the operation will be canceled. They still may result in a call to on[Query/Insert/Update/Delete]Complete after this call has completed.

Parameters

token	The token representing the operation to be canceled. If multiple operations have the same token they will all be canceled.

public void handleMessage (Message msg)

Since: API Level 1

Subclasses must implement this to receive messages.

public final void startDelete (int token, Object cookie, Uri uri, String selection, String[] selectionArgs)

Since: API Level 1

This method begins an asynchronous delete. When the delete operation is done onDeleteComplete(int, Object, int) is called.

Parameters

token	A token passed into `onDeleteComplete(int, Object, int)` to identify the delete operation.
cookie	An object that gets passed into `onDeleteComplete(int, Object, int)`
uri	the Uri passed to the delete operation.
selection	the where clause.

public final void startInsert (int token, Object cookie, Uri uri, ContentValues initialValues)

Since: API Level 1

This method begins an asynchronous insert. When the insert operation is done onInsertComplete(int, Object, Uri) is called.

Parameters

token	A token passed into `onInsertComplete(int, Object, Uri)` to identify the insert operation.
cookie	An object that gets passed into `onInsertComplete(int, Object, Uri)`
uri	the Uri passed to the insert operation.
initialValues	the ContentValues parameter passed to the insert operation.

public void startQuery (int token, Object cookie, Uri uri, String[] projection, String selection, String[] selectionArgs, String orderBy)

Since: API Level 1

This method begins an asynchronous query. When the query is done onQueryComplete(int, Object, Cursor) is called.

Parameters

token	A token passed into `onQueryComplete(int, Object, Cursor)` to identify the query.
cookie	An object that gets passed into `onQueryComplete(int, Object, Cursor)`
uri	The URI, using the content:// scheme, for the content to retrieve.
projection	A list of which columns to return. Passing null will return all columns, which is discouraged to prevent reading data from storage that isn't going to be used.
selection	A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will return all rows for the given URI.
selectionArgs	You may include ?s in selection, which will be replaced by the values from selectionArgs, in the order that they appear in the selection. The values will be bound as Strings.
orderBy	How to order the rows, formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Passing null will use the default sort order, which may be unordered.

public final void startUpdate (int token, Object cookie, Uri uri, ContentValues values, String selection, String[] selectionArgs)

Since: API Level 1

This method begins an asynchronous update. When the update operation is done onUpdateComplete(int, Object, int) is called.

Parameters

token	A token passed into `onUpdateComplete(int, Object, int)` to identify the update operation.
cookie	An object that gets passed into `onUpdateComplete(int, Object, int)`
uri	the Uri passed to the update operation.
values	the ContentValues parameter passed to the update operation.

Protected Methods

protected Handler createHandler (Looper looper)

Since: API Level 1

protected void onDeleteComplete (int token, Object cookie, int result)

Since: API Level 1

Called when an asynchronous delete is completed.

Parameters

token	the token to identify the query, passed in from `startDelete(int, Object, Uri, String, String[])`.
cookie	the cookie object that's passed in from `startDelete(int, Object, Uri, String, String[])`.
result	the result returned from the delete operation

protected void onInsertComplete (int token, Object cookie, Uri uri)

Since: API Level 1

Called when an asynchronous insert is completed.

Parameters

token	the token to identify the query, passed in from `startInsert(int, Object, Uri, ContentValues)`.
cookie	the cookie object that's passed in from `startInsert(int, Object, Uri, ContentValues)`.
uri	the uri returned from the insert operation.

protected void onQueryComplete (int token, Object cookie, Cursor cursor)

Since: API Level 1

Called when an asynchronous query is completed.

Parameters

token	the token to identify the query, passed in from `startQuery(int, Object, Uri, String[], String, String[], String)`.
cookie	the cookie object passed in from `startQuery(int, Object, Uri, String[], String, String[], String)`.
cursor	The cursor holding the results from the query.

protected void onUpdateComplete (int token, Object cookie, int result)

Since: API Level 1

Called when an asynchronous update is completed.

Parameters

token	the token to identify the query, passed in from `startUpdate(int, Object, Uri, ContentValues, String, String[])`.
cookie	the cookie object that's passed in from `startUpdate(int, Object, Uri, ContentValues, String, String[])`.
result	the result returned from the update operation

Results

Interfaces

Classes

Exceptions

AsyncQueryHandler

Class Overview

Summary

Public Constructors

public AsyncQueryHandler (ContentResolver cr)

Public Methods

public final void cancelOperation (int token)

Parameters

public void handleMessage (Message msg)

public final void startDelete (int token, Object cookie, Uri uri, String selection, String[] selectionArgs)

Parameters

public final void startInsert (int token, Object cookie, Uri uri, ContentValues initialValues)

Parameters

public void startQuery (int token, Object cookie, Uri uri, String[] projection, String selection, String[] selectionArgs, String orderBy)

Parameters

public final void startUpdate (int token, Object cookie, Uri uri, ContentValues values, String selection, String[] selectionArgs)

Parameters

Protected Methods

protected Handler createHandler (Looper looper)

protected void onDeleteComplete (int token, Object cookie, int result)

Parameters

protected void onInsertComplete (int token, Object cookie, Uri uri)

Parameters

protected void onQueryComplete (int token, Object cookie, Cursor cursor)

Parameters

protected void onUpdateComplete (int token, Object cookie, int result)

Parameters