belongs to Maven artifact com.android.support:loader:28.0.0-alpha1
Loader
public
class
Loader
extends Object
java.lang.Object | |
↳ | android.support.v4.content.Loader<D> |
![]() |
![]() |
Static library support version of the framework's Loader
.
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
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<D>
Interface that is implemented to discover when a Loader has been canceled before it finished loading its data. |
interface |
Loader.OnLoadCompleteListener<D>
Interface that is implemented to discover when a Loader has finished loading its data. |
Public constructors | |
---|---|
Loader(Context context)
Stores away the application context associated with context. |
Public methods | |
---|---|
void
|
abandon()
This function will normally be called for you automatically by
|
boolean
|
cancelLoad()
Attempt to cancel the current load task. |
void
|
commitContentChanged()
Commit that you have actually fully processed a content change that
was returned by |
String
|
dataToString(D data)
For debugging, converts an instance of the Loader's data class to a string that can be printed. |
void
|
deliverCancellation()
Informs the registered |
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
|
onContentChanged()
Called when |
void
|
registerListener(int id, OnLoadCompleteListener<D> listener)
Registers a class that will receive callbacks when a load is complete. |
void
|
registerOnLoadCanceledListener(OnLoadCanceledListener<D> listener)
Registers a listener that will receive callbacks when a load is canceled. |
void
|
reset()
This function will normally be called for you automatically by
|
void
|
rollbackContentChanged()
Report that you have abandoned the processing of a content change that
was returned by |
final
void
|
startLoading()
This function will normally be called for you automatically by
|
void
|
stopLoading()
This function will normally be called for you automatically by
|
boolean
|
takeContentChanged()
Take the current flag indicating whether the loader's content had changed while it was stopped. |
String
|
toString()
|
void
|
unregisterListener(OnLoadCompleteListener<D> listener)
Remove a listener that was previously added with |
void
|
unregisterOnLoadCanceledListener(OnLoadCanceledListener<D> listener)
Unregisters a listener that was previously added with
|
Protected methods | |
---|---|
void
|
onAbandon()
Subclasses implement this to take care of being abandoned. |
boolean
|
onCancelLoad()
Subclasses must implement this to take care of requests to |
void
|
onForceLoad()
Subclasses must implement this to take care of requests to |
void
|
onReset()
Subclasses must implement this to take care of resetting their loader,
as per |
void
|
onStartLoading()
Subclasses must implement this to take care of loading their data,
as per |
void
|
onStopLoading()
Subclasses must implement this to take care of stopping their loader,
as per |
Inherited methods | |
---|---|
![]()
java.lang.Object
|
Public constructors
Loader
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()
to retrieve
the Loader's Context, don't use the constructor argument directly.
The Context returned by getContext()
is safe to use across
Activity instances.
Parameters | |
---|---|
context |
Context : used to retrieve the application context.
|
Public methods
abandon
void 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.
cancelLoad
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.
Returns | |
---|---|
boolean |
Returns false if the task could not be canceled,
typically because it has already completed normally, or
because startLoading() hasn't been called; returns
true otherwise. When true is returned, the task
is still running and the Loader.OnLoadCanceledListener will be called
when the task completes.
|
commitContentChanged
void 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.
dataToString
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.
Parameters | |
---|---|
data |
D |
Returns | |
---|---|
String |
deliverCancellation
void deliverCancellation ()
Informs the registered Loader.OnLoadCanceledListener
that the load has been canceled.
Should only be called by subclasses.
Must be called from the process's main thread.
deliverResult
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.
Parameters | |
---|---|
data |
D : the result of the load
|
dump
void dump (String prefix, FileDescriptor fd, PrintWriter writer, String[] args)
Print the Loader's state into the given stream.
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 |
String : Additional arguments to the dump request.
|
forceLoad
void 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.
getContext
Context getContext ()
Returns | |
---|---|
Context |
an application context retrieved from the Context passed to the constructor. |
isAbandoned
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.
Returns | |
---|---|
boolean |
isReset
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.
Returns | |
---|---|
boolean |
isStarted
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.
Returns | |
---|---|
boolean |
onContentChanged
void onContentChanged ()
Called when Loader.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.
registerListener
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.
Parameters | |
---|---|
id |
|