Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

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

public class

CursorLoader

extends AsyncTaskLoader <D>

java.lang.Object
↳	android.support.v4.content.Loader <D>
	↳	android.support.v4.content.AsyncTaskLoader <D>
		↳	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	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 ()
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

boolean	cancelLoad () Attempt to cancel the current load task.
void	dump ( String prefix, FileDescriptor fd, PrintWriter writer, String[] args) Print the Loader's state into the given stream.
abstract D	loadInBackground ()
void	onCanceled (D data) Called if the task was canceled before it was completed.
void	onForceLoad () Subclasses must implement this to take care of requests to `forceLoad()` .
D	onLoadInBackground () Called on a worker thread to perform the actual load.
void	setUpdateThrottle (long delayMS) Set amount to throttle updates by.

From class android.support.v4.content.Loader

void	abandon () Tell the Loader that it is being abandoned.
void	commitContentChanged () Commit that you have actually fully processed a content change that was returned by `takeContentChanged()` .
String	dataToString (D data) For debugging, converts an instance of the Loader's data class to a string that can be printed.
void	deliverResult (D data) 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.
void	forceLoad () Force an asynchronous load.
Context	getContext ()
int	getId ()
boolean	isAbandoned () Return whether this loader has been abandoned.
boolean	isReset () Return whether this load has been reset.
boolean	isStarted () Return whether this load has been started.
void	onAbandon () Subclasses implement this to take care of being abandoned.
void	onContentChanged () Called when `Loader.ForceLoadContentObserver` detects a change.
void	onForceLoad () Subclasses must implement this to take care of requests to `forceLoad()` .
void	onReset () Subclasses must implement this to take care of resetting their loader, as per `reset()` .
void	onStartLoading () Subclasses must implement this to take care of loading their data, as per `startLoading()` .
void	onStopLoading () Subclasses must implement this to take care of stopping their loader, as per `stopLoading()` .
void	)">registerListener (int id, OnLoadCompleteListener <D> listener) Registers a class that will receive callbacks when a load is complete.
void	reset () Resets the state of the Loader.
void	rollbackContentChanged () Report that you have abandoned the processing of a content change that was returned by `takeContentChanged()` and would like to rollback to the state where there is again a pending content change.
final void	startLoading () Starts an asynchronous load of the Loader's data.
void	stopLoading () Stops delivery of updates until the next time `startLoading()` is called.
boolean	takeContentChanged () Take the current flag indicating whether the loader's content had changed while it was stopped.
String	toString () Returns a string containing a concise, human-readable description of this object.
void	)">unregisterListener ( OnLoadCompleteListener <D> listener) Remove a listener that was previously added with `)">registerListener(int, Loader.OnLoadCompleteListener )` .

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 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 ()

public void onCanceled ( Cursor cursor)

Called if the task was canceled before it was completed. Gives the class a chance to properly dispose of the result.

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

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 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 ()

public void onCanceled ( Cursor cursor)

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 ()