# Loader

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  
belongs to Maven artifact com.android.support:loader:28.0.0-alpha1  
Summary:[Nested Classes](https://developer.android.com/reference/android/support/v4/content/Loader#nestedclasses)\|[Ctors](https://developer.android.com/reference/android/support/v4/content/Loader#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v4/content/Loader#pubmethods)\|[Protected Methods](https://developer.android.com/reference/android/support/v4/content/Loader#promethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v4/content/Loader#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v4/content/Loader#)  

# Loader

| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).

`
public


class
Loader
`  
`

extends Object


``


`

|---|----------------------------------------|
| java.lang.Object                          ||
| ↳ | android.support.v4.content.Loader\<D\> |

|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v4/content/Loader#)Known Direct Subclasses [AsyncTaskLoader](https://developer.android.com/reference/android/support/v4/content/AsyncTaskLoader)\<D\> |------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| | [AsyncTaskLoader](https://developer.android.com/reference/android/support/v4/content/AsyncTaskLoader)\<D\> | Static library support version of the framework's[AsyncTaskLoader](https://developer.android.com/reference/android/content/AsyncTaskLoader.html). | |

|---|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v4/content/Loader#)Known Indirect Subclasses [CursorLoader](https://developer.android.com/reference/android/support/v4/content/CursorLoader) |-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| | [CursorLoader](https://developer.android.com/reference/android/support/v4/content/CursorLoader) | Static library support version of the framework's[CursorLoader](https://developer.android.com/reference/android/content/CursorLoader.html). | ||

<br />

*** ** * ** ***

Static library support version of the framework's[Loader](https://developer.android.com/reference/android/content/Loader.html). 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

|                                                                                                                                                   ### Nested classes                                                                                                                                                    ||
|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class`     | [Loader.ForceLoadContentObserver](https://developer.android.com/reference/android/support/v4/content/Loader.ForceLoadContentObserver) An implementation of a ContentObserver that takes care of connecting it to the Loader to have the loader re-load its data when the observer is told it has changed. |
| ` interface` | [Loader.OnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCanceledListener)`<D>` Interface that is implemented to discover when a Loader has been canceled before it finished loading its data.                                                     |
| ` interface` | [Loader.OnLoadCompleteListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCompleteListener)`<D>` Interface that is implemented to discover when a Loader has finished loading its data.                                                                             |

|                                                                                                                               ### Public constructors                                                                                                                                ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[Loader](https://developer.android.com/reference/android/support/v4/content/Loader#Loader(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context) ` Stores away the application context associated with context. |

|                                                                                                                                                                                                                                                                                                                                                              ### Public methods                                                                                                                                                                                                                                                                                                                                                              ||
|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` void`                                                                            | ` `[abandon](https://developer.android.com/reference/android/support/v4/content/Loader#abandon())`() ` This function will normally be called for you automatically by[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager)when restarting a Loader.                                                                                                                                                                                                                                                                                                                                                              |
| ` boolean`                                                                         | ` `[cancelLoad](https://developer.android.com/reference/android/support/v4/content/Loader#cancelLoad())`() ` Attempt to cancel the current load task.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ` void`                                                                            | ` `[commitContentChanged](https://developer.android.com/reference/android/support/v4/content/Loader#commitContentChanged())`() ` Commit that you have actually fully processed a content change that was returned by[takeContentChanged()](https://developer.android.com/reference/android/support/v4/content/Loader#takeContentChanged()).                                                                                                                                                                                                                                                                                                              |
| ` String`                                                                          | ` `[dataToString](https://developer.android.com/reference/android/support/v4/content/Loader#dataToString(D))`(D data) ` For debugging, converts an instance of the Loader's data class to a string that can be printed.                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ` void`                                                                            | ` `[deliverCancellation](https://developer.android.com/reference/android/support/v4/content/Loader#deliverCancellation())`() ` Informs the registered[Loader.OnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCanceledListener)that the load has been canceled.                                                                                                                                                                                                                                                                                                                                   |
| ` void`                                                                            | ` `[deliverResult](https://developer.android.com/reference/android/support/v4/content/Loader#deliverResult(D))`(D data) ` Sends the result of the load to the registered listener.                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ` void`                                                                            | ` `[dump](https://developer.android.com/reference/android/support/v4/content/Loader#dump(java.lang.String, java.io.FileDescriptor, java.io.PrintWriter, java.lang.String[]))`(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) ` Print the Loader's state into the given stream.                                                                                                                                                                                                                                                                                                                                                     |
| ` void`                                                                            | ` `[forceLoad](https://developer.android.com/reference/android/support/v4/content/Loader#forceLoad())`() ` Force an asynchronous load.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ` `[Context](https://developer.android.com/reference/android/content/Context.html) | ` `[getContext](https://developer.android.com/reference/android/support/v4/content/Loader#getContext())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ` int`                                                                             | ` `[getId](https://developer.android.com/reference/android/support/v4/content/Loader#getId())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ` boolean`                                                                         | ` `[isAbandoned](https://developer.android.com/reference/android/support/v4/content/Loader#isAbandoned())`() ` Return whether this loader has been abandoned.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ` boolean`                                                                         | ` `[isReset](https://developer.android.com/reference/android/support/v4/content/Loader#isReset())`() ` Return whether this load has been reset.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ` boolean`                                                                         | ` `[isStarted](https://developer.android.com/reference/android/support/v4/content/Loader#isStarted())`() ` Return whether this load has been started.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ` void`                                                                            | ` `[onContentChanged](https://developer.android.com/reference/android/support/v4/content/Loader#onContentChanged())`() ` Called when[Loader.ForceLoadContentObserver](https://developer.android.com/reference/android/support/v4/content/Loader.ForceLoadContentObserver)detects a change.                                                                                                                                                                                                                                                                                                                                                               |
| ` void`                                                                            | ` `[registerListener](https://developer.android.com/reference/android/support/v4/content/Loader#registerListener(int, android.support.v4.content.Loader.OnLoadCompleteListener<D>))`(int id, `[OnLoadCompleteListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCompleteListener)`<D> listener) ` Registers a class that will receive callbacks when a load is complete.                                                                                                                                                                                                                                          |
| ` void`                                                                            | ` `[registerOnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader#registerOnLoadCanceledListener(android.support.v4.content.Loader.OnLoadCanceledListener<D>))`(`[OnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCanceledListener)`<D> listener) ` Registers a listener that will receive callbacks when a load is canceled.                                                                                                                                                                                                                        |
| ` void`                                                                            | ` `[reset](https://developer.android.com/reference/android/support/v4/content/Loader#reset())`() ` This function will normally be called for you automatically by[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager)when destroying a Loader.                                                                                                                                                                                                                                                                                                                                                                  |
| ` void`                                                                            | ` `[rollbackContentChanged](https://developer.android.com/reference/android/support/v4/content/Loader#rollbackContentChanged())`() ` Report that you have abandoned the processing of a content change that was returned by[takeContentChanged()](https://developer.android.com/reference/android/support/v4/content/Loader#takeContentChanged())and would like to rollback to the state where there is again a pending content change.                                                                                                                                                                                                                  |
| ` final void`                                                                      | ` `[startLoading](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading())`() ` This function will normally be called for you automatically by[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager)when the associated fragment/activity is being started.                                                                                                                                                                                                                                                                                                                      |
| ` void`                                                                            | ` `[stopLoading](https://developer.android.com/reference/android/support/v4/content/Loader#stopLoading())`() ` This function will normally be called for you automatically by[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager)when the associated fragment/activity is being stopped.                                                                                                                                                                                                                                                                                                                        |
| ` boolean`                                                                         | ` `[takeContentChanged](https://developer.android.com/reference/android/support/v4/content/Loader#takeContentChanged())`() ` Take the current flag indicating whether the loader's content had changed while it was stopped.                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ` String`                                                                          | ` `[toString](https://developer.android.com/reference/android/support/v4/content/Loader#toString())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ` void`                                                                            | ` `[unregisterListener](https://developer.android.com/reference/android/support/v4/content/Loader#unregisterListener(android.support.v4.content.Loader.OnLoadCompleteListener<D>))`(`[OnLoadCompleteListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCompleteListener)`<D> listener) ` Remove a listener that was previously added with[registerListener(int, Loader.OnLoadCompleteListener)](https://developer.android.com/reference/android/support/v4/content/Loader#registerListener(int, android.support.v4.content.Loader.OnLoadCompleteListener<D>)).                                                    |
| ` void`                                                                            | ` `[unregisterOnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader#unregisterOnLoadCanceledListener(android.support.v4.content.Loader.OnLoadCanceledListener<D>))`(`[OnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCanceledListener)`<D> listener) ` Unregisters a listener that was previously added with[registerOnLoadCanceledListener(Loader.OnLoadCanceledListener)](https://developer.android.com/reference/android/support/v4/content/Loader#registerOnLoadCanceledListener(android.support.v4.content.Loader.OnLoadCanceledListener<D>)). |

|                                                                                                                                                 ### Protected methods                                                                                                                                                 ||
|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` void`    | ` `[onAbandon](https://developer.android.com/reference/android/support/v4/content/Loader#onAbandon())`() ` Subclasses implement this to take care of being abandoned.                                                                                                                                     |
| ` boolean` | ` `[onCancelLoad](https://developer.android.com/reference/android/support/v4/content/Loader#onCancelLoad())`() ` Subclasses must implement this to take care of requests to[cancelLoad()](https://developer.android.com/reference/android/support/v4/content/Loader#cancelLoad()).                        |
| ` void`    | ` `[onForceLoad](https://developer.android.com/reference/android/support/v4/content/Loader#onForceLoad())`() ` Subclasses must implement this to take care of requests to[forceLoad()](https://developer.android.com/reference/android/support/v4/content/Loader#forceLoad()).                            |
| ` void`    | ` `[onReset](https://developer.android.com/reference/android/support/v4/content/Loader#onReset())`() ` Subclasses must implement this to take care of resetting their loader, as per[reset()](https://developer.android.com/reference/android/support/v4/content/Loader#reset()).                         |
| ` void`    | ` `[onStartLoading](https://developer.android.com/reference/android/support/v4/content/Loader#onStartLoading())`() ` Subclasses must implement this to take care of loading their data, as per[startLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading()). |
| ` void`    | ` `[onStopLoading](https://developer.android.com/reference/android/support/v4/content/Loader#onStopLoading())`() ` Subclasses must implement this to take care of stopping their loader, as per[stopLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#stopLoading()).  |

| ### Inherited methods |
|-----------------------|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v4/content/Loader#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object`         | ` clone() `                   | | ` boolean`        | ` equals(Object arg0) `       | | ` void`           | ` finalize() `                | | ` final Class<?>` | ` getClass() `                | | ` int`            | ` hashCode() `                | | ` final void`     | ` notify() `                  | | ` final void`     | ` notifyAll() `               | | ` String`         | ` toString() `                | | ` final void`     | ` wait(long arg0, int arg1) ` | | ` final void`     | ` wait(long arg0) `           | | ` final void`     | ` wait() `                    | ||

## Public constructors

### Loader

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
Loader (Context context)
```

Stores away the application context associated with context. Since Loaders can be used across multiple activities it's dangerous to store the context directly; always use[getContext()](https://developer.android.com/reference/android/support/v4/content/Loader#getContext())to retrieve the Loader's Context, don't use the constructor argument directly. The Context returned by[getContext()](https://developer.android.com/reference/android/support/v4/content/Loader#getContext())is safe to use across Activity instances.

<br />

|                               Parameters                               ||
|-----------|-------------------------------------------------------------|
| `context` | `Context`: used to retrieve the application context. <br /> |

## Public methods

### abandon

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void abandon ()
```

This function will normally be called for you automatically by[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager)when restarting a Loader. When using a Loader with[LoaderManager](https://developer.android.com/reference/android/support/v4/app/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()](https://developer.android.com/reference/android/support/v4/content/Loader#reset())to have it retain its current data but not report any new data.

Must be called from the process's main thread.

<br />

### cancelLoad

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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.

<br />

|                                                                                                                                                                                                                                                      Returns                                                                                                                                                                                                                                                       ||
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `boolean` | Returnsfalseif the task could not be canceled, typically because it has already completed normally, or because[startLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading())hasn't been called; returnstrueotherwise. Whentrueis returned, the task is still running and the[Loader.OnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCanceledListener)will be called when the task completes. <br /> |

### commitContentChanged

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void commitContentChanged ()
```

Commit that you have actually fully processed a content change that was returned by[takeContentChanged()](https://developer.android.com/reference/android/support/v4/content/Loader#takeContentChanged()). This is for use with[rollbackContentChanged()](https://developer.android.com/reference/android/support/v4/content/Loader#rollbackContentChanged())to handle situations where a load is cancelled. Call this when you have completely processed a load without it being cancelled.

<br />

### dataToString

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
String dataToString (D data)
```

For debugging, converts an instance of the Loader's data class to a string that can be printed. Must handle a null data.

<br />

|     Parameters     ||
|--------|------------|
| `data` | `D` <br /> |

|     Returns      ||
|----------|--------|
| `String` | <br /> |

### deliverCancellation

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void deliverCancellation ()
```

Informs the registered[Loader.OnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCanceledListener)that the load has been canceled. Should only be called by subclasses. Must be called from the process's main thread.

<br />

### deliverResult

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void deliverResult (D data)
```

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.

<br />

|                 Parameters                 ||
|--------|------------------------------------|
| `data` | `D`: the result of the load <br /> |

### dump

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

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

Print the Loader's state into the given stream.

<br />

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

### forceLoad

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void forceLoad ()
```

Force an asynchronous load. Unlike[startLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading())this will ignore a previously loaded data set and load a new one. This simply calls through to the implementation's[onForceLoad()](https://developer.android.com/reference/android/support/v4/content/Loader#onForceLoad()). You generally should only call this when the loader is started -- that is,[isStarted()](https://developer.android.com/reference/android/support/v4/content/Loader#isStarted())returns true.

Must be called from the process's main thread.

<br />

### getContext

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
Context getContext ()
```

<br />

<br />

|                                                                               Returns                                                                                ||
|---------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
| [Context](https://developer.android.com/reference/android/content/Context.html) | an application context retrieved from the Context passed to the constructor. <br /> |

### getId

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
int getId ()
```

<br />

<br />

|               Returns               ||
|-------|------------------------------|
| `int` | the ID of this loader <br /> |

### isAbandoned

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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.

<br />

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |

### isReset

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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()](https://developer.android.com/reference/android/support/v4/content/Loader#reset())has been called.

<br />

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |

### isStarted

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
boolean isStarted ()
```

Return whether this load has been started. That is, its[startLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading())has been called and no calls to[stopLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#stopLoading())or[reset()](https://developer.android.com/reference/android/support/v4/content/Loader#reset())have yet been made.

<br />

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |

### onContentChanged

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onContentChanged ()
```

Called when[Loader.ForceLoadContentObserver](https://developer.android.com/reference/android/support/v4/content/Loader.ForceLoadContentObserver)detects a change. The default implementation checks to see if the loader is currently started; if so, it simply calls[forceLoad()](https://developer.android.com/reference/android/support/v4/content/Loader#forceLoad()); otherwise, it sets a flag so that[takeContentChanged()](https://developer.android.com/reference/android/support/v4/content/Loader#takeContentChanged())returns true.

Must be called from the process's main thread.

<br />

### registerListener

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void registerListener (int id, 
                OnLoadCompleteListener<D> listener)
```

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.

<br />

|                 Parameters                  ||
|------------|---------------------------------|
| `id`       | `int` <br />                    |
| `listener` | `OnLoadCompleteListener` <br /> |

### registerOnLoadCanceledListener

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void registerOnLoadCanceledListener (OnLoadCanceledListener<D> listener)
```

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.

<br />

|                               Parameters                               ||
|------------|------------------------------------------------------------|
| `listener` | `OnLoadCanceledListener`: The listener to register. <br /> |

### reset

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void reset ()
```

This function will normally be called for you automatically by[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager)when destroying a Loader. When using a Loader with[LoaderManager](https://developer.android.com/reference/android/support/v4/app/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()](https://developer.android.com/reference/android/support/v4/content/Loader#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()](https://developer.android.com/reference/android/support/v4/content/Loader#isStarted())and[isReset()](https://developer.android.com/reference/android/support/v4/content/Loader#isReset())will return the correct values, and then calls the implementation's[onReset()](https://developer.android.com/reference/android/support/v4/content/Loader#onReset()).

Must be called from the process's main thread.

<br />

### rollbackContentChanged

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void rollbackContentChanged ()
```

Report that you have abandoned the processing of a content change that was returned by[takeContentChanged()](https://developer.android.com/reference/android/support/v4/content/Loader#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.

<br />

### startLoading

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void startLoading ()
```

This function will normally be called for you automatically by[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager)when the associated fragment/activity is being started. When using a Loader with[LoaderManager](https://developer.android.com/reference/android/support/v4/app/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()](https://developer.android.com/reference/android/support/v4/content/Loader#stopLoading())will stop the delivery of callbacks.

This updates the Loader's internal state so that[isStarted()](https://developer.android.com/reference/android/support/v4/content/Loader#isStarted())and[isReset()](https://developer.android.com/reference/android/support/v4/content/Loader#isReset())will return the correct values, and then calls the implementation's[onStartLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#onStartLoading()).

Must be called from the process's main thread.

<br />

### stopLoading

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void stopLoading ()
```

This function will normally be called for you automatically by[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager)when the associated fragment/activity is being stopped. When using a Loader with[LoaderManager](https://developer.android.com/reference/android/support/v4/app/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()](https://developer.android.com/reference/android/support/v4/content/Loader#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()](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading())is later called.

This updates the Loader's internal state so that[isStarted()](https://developer.android.com/reference/android/support/v4/content/Loader#isStarted())will return the correct value, and then calls the implementation's[onStopLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#onStopLoading()).

Must be called from the process's main thread.

<br />

### takeContentChanged

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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.

<br />

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |

### toString

```
String toString ()
```

<br />

<br />

|     Returns      ||
|----------|--------|
| `String` | <br /> |

### unregisterListener

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void unregisterListener (OnLoadCompleteListener<D> listener)
```

Remove a listener that was previously added with[registerListener(int, Loader.OnLoadCompleteListener)](https://developer.android.com/reference/android/support/v4/content/Loader#registerListener(int, android.support.v4.content.Loader.OnLoadCompleteListener<D>)). Must be called from the process's main thread.

<br />

|                 Parameters                  ||
|------------|---------------------------------|
| `listener` | `OnLoadCompleteListener` <br /> |

### unregisterOnLoadCanceledListener

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void unregisterOnLoadCanceledListener (OnLoadCanceledListener<D> listener)
```

Unregisters a listener that was previously added with[registerOnLoadCanceledListener(Loader.OnLoadCanceledListener)](https://developer.android.com/reference/android/support/v4/content/Loader#registerOnLoadCanceledListener(android.support.v4.content.Loader.OnLoadCanceledListener<D>)). Must be called from the process's main thread.

<br />

|                                Parameters                                ||
|------------|--------------------------------------------------------------|
| `listener` | `OnLoadCanceledListener`: The listener to unregister. <br /> |

## Protected methods

### onAbandon

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onAbandon ()
```

Subclasses implement this to take care of being abandoned. This is an optional intermediate state prior to[onReset()](https://developer.android.com/reference/android/support/v4/content/Loader#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()](https://developer.android.com/reference/android/support/v4/content/Loader#onReset())happens. You can retrieve the current abandoned state with[isAbandoned()](https://developer.android.com/reference/android/support/v4/content/Loader#isAbandoned()). This will always be called from the process's main thread.

<br />

### onCancelLoad

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
boolean onCancelLoad ()
```

Subclasses must implement this to take care of requests to[cancelLoad()](https://developer.android.com/reference/android/support/v4/content/Loader#cancelLoad()). This will always be called from the process's main thread.

<br />

|                                                                                                                                                                                                                                                      Returns                                                                                                                                                                                                                                                       ||
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `boolean` | Returnsfalseif the task could not be canceled, typically because it has already completed normally, or because[startLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading())hasn't been called; returnstrueotherwise. Whentrueis returned, the task is still running and the[Loader.OnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCanceledListener)will be called when the task completes. <br /> |

### onForceLoad

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onForceLoad ()
```

Subclasses must implement this to take care of requests to[forceLoad()](https://developer.android.com/reference/android/support/v4/content/Loader#forceLoad()). This will always be called from the process's main thread.

<br />

### onReset

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onReset ()
```

Subclasses must implement this to take care of resetting their loader, as per[reset()](https://developer.android.com/reference/android/support/v4/content/Loader#reset()). This is not called by clients directly, but as a result of a call to[reset()](https://developer.android.com/reference/android/support/v4/content/Loader#reset()). This will always be called from the process's main thread.

<br />

### onStartLoading

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onStartLoading ()
```

Subclasses must implement this to take care of loading their data, as per[startLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading()). This is not called by clients directly, but as a result of a call to[startLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#startLoading()). This will always be called from the process's main thread.

<br />

### onStopLoading

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onStopLoading ()
```

Subclasses must implement this to take care of stopping their loader, as per[stopLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#stopLoading()). This is not called by clients directly, but as a result of a call to[stopLoading()](https://developer.android.com/reference/android/support/v4/content/Loader#stopLoading()). This will always be called from the process's main thread.

<br />

-

  ## Interfaces

  - [Loader.OnLoadCanceledListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCanceledListener)
  - [Loader.OnLoadCompleteListener](https://developer.android.com/reference/android/support/v4/content/Loader.OnLoadCompleteListener)
-

  ## Classes

  - [AsyncTaskLoader](https://developer.android.com/reference/android/support/v4/content/AsyncTaskLoader)
  - [ContentResolverCompat](https://developer.android.com/reference/android/support/v4/content/ContentResolverCompat)
  - [ContextCompat](https://developer.android.com/reference/android/support/v4/content/ContextCompat)
  - [CursorLoader](https://developer.android.com/reference/android/support/v4/content/CursorLoader)
  - [FileProvider](https://developer.android.com/reference/android/support/v4/content/FileProvider)
  - [IntentCompat](https://developer.android.com/reference/android/support/v4/content/IntentCompat)
  - [Loader](https://developer.android.com/reference/android/support/v4/content/Loader)
  - [Loader.ForceLoadContentObserver](https://developer.android.com/reference/android/support/v4/content/Loader.ForceLoadContentObserver)
  - [LocalBroadcastManager](https://developer.android.com/reference/android/support/v4/content/LocalBroadcastManager)
  - [MimeTypeFilter](https://developer.android.com/reference/android/support/v4/content/MimeTypeFilter)
  - [PermissionChecker](https://developer.android.com/reference/android/support/v4/content/PermissionChecker)
  - [SharedPreferencesCompat](https://developer.android.com/reference/android/support/v4/content/SharedPreferencesCompat)
  - [SharedPreferencesCompat.EditorCompat](https://developer.android.com/reference/android/support/v4/content/SharedPreferencesCompat.EditorCompat)
  - [WakefulBroadcastReceiver](https://developer.android.com/reference/android/support/v4/content/WakefulBroadcastReceiver)