CursorLoader

Kotlin |Java

open class CursorLoader : AsyncTaskLoader<Cursor!>

kotlin.Any
↳	androidx.loader.content.Loader<D>
	↳	androidx.loader.content.AsyncTaskLoader<android.database.Cursor>
		↳	androidx.loader.content.CursorLoader

Static library support version of the framework's android.content.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
`<init>(@NonNull context: Context)` Creates an empty unspecified CursorLoader.
`<init>(@NonNull context: Context, @NonNull uri: Uri, @Nullable projection: Array<String!>?, @Nullable selection: String?, @Nullable selectionArgs: Array<String!>?, @Nullable sortOrder: String?)` Creates a fully-specified CursorLoader.

Public methods
open Unit	`cancelLoadInBackground()`
open Unit	`deliverResult(cursor: Cursor?)`
open Unit	`dump(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)`
open Array<String!>?	`getProjection()`
open String?	`getSelection()`
open Array<String!>?	`getSelectionArgs()`
open String?	`getSortOrder()`
open Uri	`getUri()`
open Cursor?	`loadInBackground()`
open Unit	`onCanceled(cursor: Cursor?)`
open Unit	`setProjection(@Nullable projection: Array<String!>?)`
open Unit	`setSelection(@Nullable selection: String?)`
open Unit	`setSelectionArgs(@Nullable selectionArgs: Array<String!>?)`
open Unit	`setSortOrder(@Nullable sortOrder: String?)`
open Unit	`setUri(@NonNull uri: Uri)`

Protected methods
open Unit	`onReset()`
open Unit	`onStartLoading()` Starts an asynchronous load of the contacts list data.
open Unit	`onStopLoading()` Must be called from the UI thread

Inherited functions

From class Loader

`Unit`	`abandon()` This function will normally be called for you automatically by `LoaderManager` when restarting a Loader. When using a Loader with `LoaderManager`, you must not call this method yourself, or you will conflict with its management of the Loader. Tell the Loader that it is being abandoned. This is called prior to `reset` to have it retain its current data but not report any new data. Must be called from the process's main thread.
`Boolean`	`cancelLoad()` Attempt to cancel the current load task. Must be called on the main thread of the process. Cancellation is not an immediate operation, since the load is performed in a background thread. If there is currently a load in progress, this method requests that the load be canceled, and notes this is the case; once the background thread has completed its work its remaining state will be cleared. If another load request comes in during this time, it will be held until the canceled load is complete.
`Unit`	`commitContentChanged()` Commit that you have actually fully processed a content change that was returned by `takeContentChanged`. This is for use with `rollbackContentChanged()` to handle situations where a load is cancelled. Call this when you have completely processed a load without it being cancelled.
`String`	`dataToString(@Nullable data: D?)` For debugging, converts an instance of the Loader's data class to a string that can be printed. Must handle a null data.
`Unit`	`deliverCancellation()` Informs the registered `OnLoadCanceledListener` that the load has been canceled. Should only be called by subclasses. Must be called from the process's main thread.
`Unit`	`deliverResult(@Nullable data: D?)` 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.
`Unit`	`forceLoad()` Force an asynchronous load. Unlike `startLoading()` this will ignore a previously loaded data set and load a new one. This simply calls through to the implementation's `onForceLoad()`. You generally should only call this when the loader is started -- that is, `isStarted()` returns true. Must be called from the process's main thread.
`Context`	`getContext()`
`Int`	`getId()`
`Boolean`	`isAbandoned()` Return whether this loader has been abandoned. In this state, the loader must not report any new data, and must keep its last reported data valid until it is finally reset.
`Boolean`	`isReset()` Return whether this load has been reset. That is, either the loader has not yet been started for the first time, or its `reset()` has been called.
`Boolean`	`isStarted()` Return whether this load has been started. That is, its `startLoading()` has been called and no calls to `stopLoading()` or `reset()` have yet been made.
`Unit`	`onAbandon()` Subclasses implement this to take care of being abandoned. This is an optional intermediate state prior to `onReset()` -- it means that the client is no longer interested in any new data from the loader, so the loader must not report any further updates. However, the loader must keep its last reported data valid until the final `onReset()` happens. You can retrieve the current abandoned state with `isAbandoned`. This will always be called from the process's main thread.
`Unit`	`onContentChanged()` Called when `ForceLoadContentObserver` detects a change. The default implementation checks to see if the loader is currently started; if so, it simply calls `forceLoad()`; otherwise, it sets a flag so that `takeContentChanged()` returns true. Must be called from the process's main thread.
`Unit`	`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.
`Unit`	`onStartLoading()` Subclasses must implement this to take care of loading their data, as per `startLoading()`. This is not called by clients directly, but as a result of a call to `startLoading()`. This will always be called from the process's main thread.
`Unit`	`onStopLoading()` Subclasses must implement this to take care of stopping their loader, as per `stopLoading()`. This is not called by clients directly, but as a result of a call to `stopLoading()`. This will always be called from the process's main thread.
`Unit`	`registerListener(id: Int, @NonNull listener: Loader.OnLoadCompleteListener<D>)` Registers a class that will receive callbacks when a load is complete. The callback will be called on the process's main thread so it's safe to pass the results to widgets. Must be called from the process's main thread.
`Unit`	`registerOnLoadCanceledListener(@NonNull listener: Loader.OnLoadCanceledListener<D>)` Registers a listener that will receive callbacks when a load is canceled. The callback will be called on the process's main thread so it's safe to pass the results to widgets. Must be called from the process's main thread.
`Unit`	`reset()` This function will normally be called for you automatically by `LoaderManager` when destroying a Loader. When using a Loader with `LoaderManager`, you must not call this method yourself, or you will conflict with its management of the Loader. Resets the state of the Loader. The Loader should at this point free all of its resources, since it may never be called again; however, its `startLoading()` may later be called at which point it must be able to start running again. This updates the Loader's internal state so that `isStarted()` and `isReset()` will return the correct values, and then calls the implementation's `onReset()`. Must be called from the process's main thread.
`Unit`	`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. This is to handle the case where a data load due to a content change has been canceled before its data was delivered back to the loader.
`Unit`	`startLoading()` This function will normally be called for you automatically by `LoaderManager` when the associated fragment/activity is being started. When using a Loader with `LoaderManager`, you must not call this method yourself, or you will conflict with its management of the Loader. Starts an asynchronous load of the Loader's data. When the result is ready the callbacks will be called on the process's main thread. If a previous load has been completed and is still valid the result may be passed to the callbacks immediately. The loader will monitor the source of the data set and may deliver future callbacks if the source changes. Calling `stopLoading` will stop the delivery of callbacks. This updates the Loader's internal state so that `isStarted()` and `isReset()` will return the correct values, and then calls the implementation's `onStartLoading()`. Must be called from the process's main thread.
`Unit`	`stopLoading()` This function will normally be called for you automatically by `LoaderManager` when the associated fragment/activity is being stopped. When using a Loader with `LoaderManager`, you must not call this method yourself, or you will conflict with its management of the Loader. Stops delivery of updates until the next time `startLoading()` is called. Implementations should not invalidate their data at this point -- clients are still free to use the last data the loader reported. They will, however, typically stop reporting new data if the data changes; they can still monitor for changes, but must not report them to the client until and if `startLoading()` is later called. This updates the Loader's internal state so that `isStarted()` will return the correct value, and then calls the implementation's `onStopLoading()`. Must be called from the process's main thread.
`Boolean`	`takeContentChanged()` Take the current flag indicating whether the loader's content had changed while it was stopped. If it had, true is returned and the flag is cleared.
`String`	`toString()`
`Unit`	`unregisterListener(@NonNull listener: Loader.OnLoadCompleteListener<D>)` Remove a listener that was previously added with `registerListener`. Must be called from the process's main thread.
`Unit`	`unregisterOnLoadCanceledListener(@NonNull listener: Loader.OnLoadCanceledListener<D>)` Unregisters a listener that was previously added with `registerOnLoadCanceledListener`. Must be called from the process's main thread.

From class AsyncTaskLoader

`Executor`	`getExecutor()` Returns the `Executor` to use for this `Loader`'s `AsyncTask`s. By default `AsyncTask#THREAD_POOL_EXECUTOR` will be used. Override this method to return a custom executor. Note that this method will only be called once before this `Loader`'s first `AsyncTask` is run. It is up to the `Loader` to shut down the `Executor` at the appropriate place (e.g. in `onAbandon()`) if necessary.
`Boolean`	`isLoadInBackgroundCanceled()` Returns true if the current invocation of `loadInBackground` is being canceled.
`Boolean`	`onCancelLoad()`
`Unit`	`onForceLoad()`
`D?`	`onLoadInBackground()` Calls `loadInBackground()`. This method is reserved for use by the loader framework. Subclasses should override `loadInBackground` instead of this method.
`Unit`	`setUpdateThrottle(delayMS: Long)` Set amount to throttle updates by. This is the minimum time from when the last `loadInBackground()` call has completed until a new load is scheduled.

Public constructors

<init>

CursorLoader(@NonNull 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.

<init>

CursorLoader(
    @NonNull context: Context, 
    @NonNull uri: Uri, 
    @Nullable projection: Array<String!>?, 
    @Nullable selection: String?, 
    @Nullable selectionArgs: Array<String!>?, 
    @Nullable sortOrder: String?)

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

cancelLoadInBackground

open fun cancelLoadInBackground(): Unit

deliverResult

open fun deliverResult(cursor: Cursor?): Unit

dump

open fun dump(
    prefix: String!, 
    fd: FileDescriptor!, 
    writer: PrintWriter!, 
    args: Array<String!>!
): Unit

Deprecated: Consider using LoaderManager#enableDebugLogging(boolean) to understand the series of operations performed by LoaderManager.

Parameters
`prefix`	String!: Text to print at the front of each line.
`fd`	FileDescriptor!: The raw file descriptor that the dump is being sent to.
`writer`	PrintWriter!: A PrintWriter to which the dump is to be set.
`args`	Array<String!>!: Additional arguments to the dump request.

getProjection

@Nullable open fun getProjection(): Array<String!>?

getSelection

@Nullable open fun getSelection(): String?

getSelectionArgs

@Nullable open fun getSelectionArgs(): Array<String!>?

getSortOrder

@Nullable open fun getSortOrder(): String?

getUri

@NonNull open fun getUri(): Uri

loadInBackground

open fun loadInBackground(): Cursor?

onCanceled

open fun onCanceled(cursor: Cursor?): Unit

setProjection

open fun setProjection(@Nullable projection: Array<String!>?): Unit

setSelection

open fun setSelection(@Nullable selection: String?): Unit

setSelectionArgs

open fun setSelectionArgs(@Nullable selectionArgs: Array<String!>?): Unit

setSortOrder

open fun setSortOrder(@Nullable sortOrder: String?): Unit

setUri

open fun setUri(@NonNull uri: Uri): Unit

Protected methods

onReset

protected open fun onReset(): Unit

onStartLoading

protected open fun onStartLoading(): Unit

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

onStopLoading

protected open fun onStopLoading(): Unit

Must be called from the UI thread