CursorLoader - Android SDK

Annotations
- PermissionChecker.PermissionResult
Interfaces
- Loader.OnLoadCanceledListener
- Loader.OnLoadCompleteListener
Classes

Summary: Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

public class

CursorLoader

extends AsyncTaskLoader<Cursor>

java.lang.Object
↳	android.support.v4.content.Loader<android.database.Cursor>
	↳	android.support.v4.content.AsyncTaskLoader<android.database.Cursor>
		↳	android.support.v4.content.CursorLoader

Class Overview

Static library support version of the framework's CursorLoader. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework SDK documentation for a class overview.

Summary

Public Constructors
	CursorLoader(Context context) Creates an empty unspecified CursorLoader.
	CursorLoader(Context context, Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) Creates a fully-specified CursorLoader.

Public Methods
void	cancelLoadInBackground() Called on the main thread to abort a load in progress.
void	deliverResult(Cursor cursor) Sends the result of the load to the registered listener.
void	dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) Print the Loader's state into the given stream.
String[]	getProjection()
String	getSelection()
String[]	getSelectionArgs()
String	getSortOrder()
Uri	getUri()
Cursor	loadInBackground() Called on a worker thread to perform the actual load and to return the result of the load operation.
void	onCanceled(Cursor cursor) Called if the task was canceled before it was completed.
void	setProjection(String[] projection)
void	setSelection(String selection)
void	setSelectionArgs(String[] selectionArgs)
void	setSortOrder(String sortOrder)
void	setUri(Uri uri)

Protected Methods
void	onReset() Subclasses must implement this to take care of resetting their loader, as per `reset()`.
void	onStartLoading() Starts an asynchronous load of the contacts list data.
void	onStopLoading() Must be called from the UI thread

[Expand]

Inherited Methods

From class android.support.v4.content.AsyncTaskLoader

From class android.support.v4.content.Loader

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 CursorLoader (Context context)

Creates an empty unspecified CursorLoader. You must follow this with calls to setUri(Uri), setSelection(String), etc to specify the query to perform.

public CursorLoader (Context context, Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)

Creates a fully-specified CursorLoader. See ContentResolver.query() for documentation on the meaning of the parameters. These will be passed as-is to that call.

Public Methods

public void cancelLoadInBackground ()

Called on the main thread to abort a load in progress. Override this method to abort the current invocation of loadInBackground() that is running in the background on a worker thread. This method should do nothing if loadInBackground() has not started running or if it has already finished.

public void deliverResult (Cursor cursor)

Sends the result of the load to the registered listener. Should only be called by subclasses. Must be called from the process's main thread.

Parameters

cursor	the result of the load

public void dump (String prefix, FileDescriptor fd, PrintWriter writer, String[] args)

Print the Loader's state into the given stream.

Parameters

prefix	Text to print at the front of each line.
fd	The raw file descriptor that the dump is being sent to.
writer	A PrintWriter to which the dump is to be set.
args	Additional arguments to the dump request.

public String[] getProjection ()

public String getSelection ()

public String[] getSelectionArgs ()

public String getSortOrder ()

public Uri getUri ()

public Cursor loadInBackground ()

Called on a worker thread to perform the actual load and to return the result of the load operation. Implementations should not deliver the result directly, but should return them from this method, which will eventually end up calling deliverResult(D) on the UI thread. If implementations need to process the results on the UI thread they may override deliverResult(D) and do so there. To support cancellation, this method should periodically check the value of isLoadInBackgroundCanceled() and terminate when it returns true. Subclasses may also override cancelLoadInBackground() to interrupt the load directly instead of polling isLoadInBackgroundCanceled(). When the load is canceled, this method may either return normally or throw OperationCanceledException. In either case, the Loader will call onCanceled(D) to perform post-cancellation cleanup and to dispose of the result object, if any.

Returns

The result of the load operation.

public void onCanceled (Cursor cursor)

Called if the task was canceled before it was completed. Gives the class a chance to clean up post-cancellation and to properly dispose of the result.

Parameters

cursor	The value that was returned by `loadInBackground()`, or null if the task threw `OperationCanceledException`.

public void setProjection (String[] projection)

public void setSelection (String selection)

public void setSelectionArgs (String[] selectionArgs)

public void setSortOrder (String sortOrder)

public void setUri (Uri uri)

Protected Methods

protected void onReset ()

Subclasses must implement this to take care of resetting their loader, as per reset(). This is not called by clients directly, but as a result of a call to reset(). This will always be called from the process's main thread.

protected void onStartLoading ()

Starts an asynchronous load of the contacts list data. When the result is ready the callbacks will be called on the UI thread. If a previous load has been completed and is still valid the result may be passed to the callbacks immediately. Must be called from the UI thread

protected void onStopLoading ()

Must be called from the UI thread

Results

Annotations

Interfaces

Classes

CursorLoader

Class Overview

Summary

Public Constructors

public CursorLoader (Context context)

public CursorLoader (Context context, Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)

Public Methods

public void cancelLoadInBackground ()

public void deliverResult (Cursor cursor)

Parameters

public void dump (String prefix, FileDescriptor fd, PrintWriter writer, String[] args)

Parameters

public String[] getProjection ()

public String getSelection ()

public String[] getSelectionArgs ()

public String getSortOrder ()

public Uri getUri ()

public Cursor loadInBackground ()

Returns

public void onCanceled (Cursor cursor)

Parameters

public void setProjection (String[] projection)

public void setSelection (String selection)

public void setSelectionArgs (String[] selectionArgs)

public void setSortOrder (String sortOrder)

public void setUri (Uri uri)

Protected Methods

protected void onReset ()

protected void onStartLoading ()

protected void onStopLoading ()