LoaderManager.java revision b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23
1c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn/*
2c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * Copyright (C) 2010 The Android Open Source Project
3c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn *
4c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * Licensed under the Apache License, Version 2.0 (the "License");
5c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * you may not use this file except in compliance with the License.
6c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * You may obtain a copy of the License at
7c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn *
8c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn *      http://www.apache.org/licenses/LICENSE-2.0
9c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn *
10c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * Unless required by applicable law or agreed to in writing, software
11c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * distributed under the License is distributed on an "AS IS" BASIS,
12c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * See the License for the specific language governing permissions and
14c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn * limitations under the License.
15c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn */
16c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
17c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackbornpackage android.app;
18c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
19c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackbornimport android.content.Loader;
20c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackbornimport android.os.Bundle;
21a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackbornimport android.util.DebugUtils;
225e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackbornimport android.util.Log;
23c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackbornimport android.util.SparseArray;
24c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
2530d7189067524000c738c188c4ff91f84f474d25Dianne Hackbornimport java.io.FileDescriptor;
2630d7189067524000c738c188c4ff91f84f474d25Dianne Hackbornimport java.io.PrintWriter;
270e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackbornimport java.lang.reflect.Modifier;
2830d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn
29c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn/**
304911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn * Interface associated with an {@link Activity} or {@link Fragment} for managing
31c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * one or more {@link android.content.Loader} instances associated with it.  This
32c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * helps an application manage longer-running operations in conjunction with the
33c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * Activity or Fragment lifecycle; the most common use of this is with a
34c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * {@link android.content.CursorLoader}, however applications are free to write
35c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * their own loaders for loading other types of data.
36c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn *
37f9dd34f4d3203fd50363b3b0247c5d0db6fe2c8fDianne Hackborn * While the LoaderManager API was introduced in
38f9dd34f4d3203fd50363b3b0247c5d0db6fe2c8fDianne Hackborn * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, a version of the API
39f9dd34f4d3203fd50363b3b0247c5d0db6fe2c8fDianne Hackborn * is also available for use on older platforms.  See the blog post
40f9dd34f4d3203fd50363b3b0247c5d0db6fe2c8fDianne Hackborn * <a href="http://android-developers.blogspot.com/2011/03/fragments-for-all.html">
41f9dd34f4d3203fd50363b3b0247c5d0db6fe2c8fDianne Hackborn * Fragments For All</a> for more details.
42f9dd34f4d3203fd50363b3b0247c5d0db6fe2c8fDianne Hackborn *
43c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * <p>As an example, here is the full implementation of a {@link Fragment}
44c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * that displays a {@link android.widget.ListView} containing the results of
45c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * a query against the contacts content provider.  It uses a
46c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn * {@link android.content.CursorLoader} to manage the query on the provider.
47c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn *
48f9dd34f4d3203fd50363b3b0247c5d0db6fe2c8fDianne Hackborn * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/LoaderCursor.java
49c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn *      fragment_cursor}
50b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez *
51b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * <div class="special reference">
52b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * <h3>Developer Guides</h3>
53b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * <p>For more information about using loaders, read the
54b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * <a href="{@docRoot}guide/topics/fundamentals/loaders.html">Loaders</a> developer guide.</p>
55b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * </div>
56c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn */
57ab36acb39941ce981dddda9f9cf4d2d23a56fd26Dianne Hackbornpublic abstract class LoaderManager {
58c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    /**
59c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn     * Callback interface for a client to interact with the manager.
60c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn     */
61c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    public interface LoaderCallbacks<D> {
624911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn        /**
634911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         * Instantiate and return a new Loader for the given ID.
644911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         *
654911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         * @param id The ID whose loader is to be created.
664911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         * @param args Any arguments supplied by the caller.
674911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         * @return Return a new Loader instance that is ready to start loading.
684911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         */
69c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        public Loader<D> onCreateLoader(int id, Bundle args);
704911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn
714911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn        /**
72fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn         * Called when a previously created loader has finished its load.  Note
73fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn         * that normally an application is <em>not</em> allowed to commit fragment
74fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn         * transactions while in this call, since it can happen after an
7548e7b458694acdf3a4fc58e62437f1dbc4f29d83Dianne Hackborn         * activity's state is saved.  See {@link FragmentManager#beginTransaction()
76fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn         * FragmentManager.openTransaction()} for further discussion on this.
77fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn         *
78c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * <p>This function is guaranteed to be called prior to the release of
79c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * the last data that was supplied for this Loader.  At this point
80c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * you should remove all use of the old data (since it will be released
81c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * soon), but should not do your own release of the data since its Loader
82c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * owns it and will take care of that.  The Loader will take care of
83c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * management of its data so you don't have to.  In particular:
84c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         *
85c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * <ul>
86c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * <li> <p>The Loader will monitor for changes to the data, and report
87c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * them to you through new calls here.  You should not monitor the
88c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * data yourself.  For example, if the data is a {@link android.database.Cursor}
89c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * and you place it in a {@link android.widget.CursorAdapter}, use
90c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * the {@link android.widget.CursorAdapter#CursorAdapter(android.content.Context,
91c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * android.database.Cursor, int)} constructor <em>without</em> passing
92c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * in either {@link android.widget.CursorAdapter#FLAG_AUTO_REQUERY}
93c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * or {@link android.widget.CursorAdapter#FLAG_REGISTER_CONTENT_OBSERVER}
94c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * (that is, use 0 for the flags argument).  This prevents the CursorAdapter
95c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * from doing its own observing of the Cursor, which is not needed since
96c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * when a change happens you will get a new Cursor throw another call
97c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * here.
98c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * <li> The Loader will release the data once it knows the application
99c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * is no longer using it.  For example, if the data is
100c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * a {@link android.database.Cursor} from a {@link android.content.CursorLoader},
101c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * you should not call close() on it yourself.  If the Cursor is being placed in a
102c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * {@link android.widget.CursorAdapter}, you should use the
103c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * {@link android.widget.CursorAdapter#swapCursor(android.database.Cursor)}
104c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * method so that the old Cursor is not closed.
105c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * </ul>
106c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         *
1074911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         * @param loader The Loader that has finished.
1084911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         * @param data The data generated by the Loader.
1094911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn         */
110c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        public void onLoadFinished(Loader<D> loader, D data);
111c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn
112c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn        /**
113c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * Called when a previously created loader is being reset, and thus
114c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * making its data unavailable.  The application should at this point
115c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * remove any references it has to the Loader's data.
116c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         *
117c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         * @param loader The Loader that is being reset.
118c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn         */
119c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn        public void onLoaderReset(Loader<D> loader);
120c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
121c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
1224911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn    /**
1234911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * Ensures a loader is initialized and active.  If the loader doesn't
1244911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * already exist, one is created and (if the activity/fragment is currently
1254911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * started) starts the loader.  Otherwise the last created
1264911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * loader is re-used.
1274911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     *
1284911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * <p>In either case, the given callback is associated with the loader, and
1294911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * will be called as the loader state changes.  If at the point of call
1304911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * the caller is in its started state, and the requested loader
1314911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * already exists and has generated its data, then
132c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * callback {@link LoaderCallbacks#onLoadFinished} will
1334911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * be called immediately (inside of this function), so you must be prepared
1344911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * for this to happen.
135c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     *
136c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * @param id A unique identifier for this loader.  Can be whatever you want.
137c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * Identifiers are scoped to a particular LoaderManager instance.
138c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * @param args Optional arguments to supply to the loader at construction.
139a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn     * If a loader already exists (a new one does not need to be created), this
140a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn     * parameter will be ignored and the last arguments continue to be used.
141c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * @param callback Interface the LoaderManager will call to report about
142c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * changes in the state of the loader.  Required.
1434911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     */
144ab36acb39941ce981dddda9f9cf4d2d23a56fd26Dianne Hackborn    public abstract <D> Loader<D> initLoader(int id, Bundle args,
1454911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            LoaderManager.LoaderCallbacks<D> callback);
1464911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn
1474911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn    /**
148c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * Starts a new or restarts an existing {@link android.content.Loader} in
149c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * this manager, registers the callbacks to it,
1504911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * and (if the activity/fragment is currently started) starts loading it.
1514911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * If a loader with the same id has previously been
1524911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * started it will automatically be destroyed when the new loader completes
1534911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * its work. The callback will be delivered before the old loader
1544911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * is destroyed.
155c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     *
156c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * @param id A unique identifier for this loader.  Can be whatever you want.
157c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * Identifiers are scoped to a particular LoaderManager instance.
158c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * @param args Optional arguments to supply to the loader at construction.
159c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * @param callback Interface the LoaderManager will call to report about
160c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn     * changes in the state of the loader.  Required.
1614911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     */
162ab36acb39941ce981dddda9f9cf4d2d23a56fd26Dianne Hackborn    public abstract <D> Loader<D> restartLoader(int id, Bundle args,
1634911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            LoaderManager.LoaderCallbacks<D> callback);
1644911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn
1654911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn    /**
166f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn     * Stops and removes the loader with the given ID.  If this loader
167f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn     * had previously reported data to the client through
168f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn     * {@link LoaderCallbacks#onLoadFinished(Loader, Object)}, a call
169f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn     * will be made to {@link LoaderCallbacks#onLoaderReset(Loader)}.
1704911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     */
171c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn    public abstract void destroyLoader(int id);
172c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn
173c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn    /**
1744911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * Return the Loader with the given id or null if no matching Loader
1754911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     * is found.
1764911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn     */
177ab36acb39941ce981dddda9f9cf4d2d23a56fd26Dianne Hackborn    public abstract <D> Loader<D> getLoader(int id);
17830d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn
17930d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn    /**
18030d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn     * Print the LoaderManager's state into the given stream.
18130d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn     *
18230d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn     * @param prefix Text to print at the front of each line.
18330d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn     * @param fd The raw file descriptor that the dump is being sent to.
18430d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn     * @param writer A PrintWriter to which the dump is to be set.
18530d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn     * @param args Additional arguments to the dump request.
18630d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn     */
18730d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn    public abstract void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args);
188a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn
189a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn    /**
190a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn     * Control whether the framework's internal loader manager debugging
191a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn     * logs are turned on.  If enabled, you will see output in logcat as
192a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn     * the framework performs loader operations.
193a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn     */
194a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn    public static void enableDebugLogging(boolean enabled) {
195a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        LoaderManagerImpl.DEBUG = enabled;
196a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn    }
1974911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn}
1984911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn
199ab36acb39941ce981dddda9f9cf4d2d23a56fd26Dianne Hackbornclass LoaderManagerImpl extends LoaderManager {
200a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn    static final String TAG = "LoaderManager";
201ec541e1787b39605200584042fa1e144923eeb4fDianne Hackborn    static boolean DEBUG = false;
2025e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
2035e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn    // These are the currently active loaders.  A loader is here
2045e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn    // from the time its load is started until it has been explicitly
2055e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn    // stopped or restarted by the application.
2064911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn    final SparseArray<LoaderInfo> mLoaders = new SparseArray<LoaderInfo>();
2075e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
2085e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn    // These are previously run loaders.  This list is maintained internally
2095e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn    // to avoid destroying a loader while an application is still using it.
2105e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn    // It allows an application to restart a loader, but continue using its
2115e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn    // previously run loader until the new loader's data is available.
2124911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn    final SparseArray<LoaderInfo> mInactiveLoaders = new SparseArray<LoaderInfo>();
2135e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
214fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn    Activity mActivity;
2154911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn    boolean mStarted;
2164911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn    boolean mRetaining;
2174911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn    boolean mRetainingStarted;
2186e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
2196e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    boolean mCreatingLoader;
2204911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn
221c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    final class LoaderInfo implements Loader.OnLoadCompleteListener<Object> {
2222707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        final int mId;
2232707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        final Bundle mArgs;
2242707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        LoaderManager.LoaderCallbacks<Object> mCallbacks;
2252707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        Loader<Object> mLoader;
2266e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        boolean mHaveData;
2276e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        boolean mDeliveredData;
2282707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        Object mData;
2292707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        boolean mStarted;
2302707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        boolean mRetaining;
2312707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        boolean mRetainingStarted;
232afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn        boolean mReportNextStart;
2332707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        boolean mDestroyed;
2342707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        boolean mListenerRegistered;
23530d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn
2366e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        LoaderInfo mPendingLoader;
2376e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
2382707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        public LoaderInfo(int id, Bundle args, LoaderManager.LoaderCallbacks<Object> callbacks) {
2392707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mId = id;
2402707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mArgs = args;
2412707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mCallbacks = callbacks;
2422707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
2432707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
2442707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        void start() {
2452707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            if (mRetaining && mRetainingStarted) {
2462707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                // Our owner is started, but we were being retained from a
2472707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                // previous instance in the started state...  so there is really
2482707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                // nothing to do here, since the loaders are still started.
2492707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                mStarted = true;
2502707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                return;
2512707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            }
2522707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
2534911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            if (mStarted) {
2544911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn                // If loader already started, don't restart.
2554911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn                return;
2564911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            }
2574911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn
2580e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn            mStarted = true;
2590e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn
2605e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            if (DEBUG) Log.v(TAG, "  Starting: " + this);
2612707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            if (mLoader == null && mCallbacks != null) {
2622707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn               mLoader = mCallbacks.onCreateLoader(mId, mArgs);
2632707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            }
2642707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            if (mLoader != null) {
2650e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn                if (mLoader.getClass().isMemberClass()
2660e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn                        && !Modifier.isStatic(mLoader.getClass().getModifiers())) {
267a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                    throw new IllegalArgumentException(
2680e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn                            "Object returned from onCreateLoader must not be a non-static inner member class: "
269a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                            + mLoader);
270a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                }
2714911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn                if (!mListenerRegistered) {
2724911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn                    mLoader.registerListener(mId, this);
2734911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn                    mListenerRegistered = true;
2744911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn                }
2752707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                mLoader.startLoading();
2762707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            }
2772707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
2782707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
2792707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        void retain() {
2805e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            if (DEBUG) Log.v(TAG, "  Retaining: " + this);
2812707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mRetaining = true;
2822707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mRetainingStarted = mStarted;
2832707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mStarted = false;
2842707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mCallbacks = null;
2852707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
2862707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
2872707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        void finishRetain() {
2882707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            if (mRetaining) {
2895e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                if (DEBUG) Log.v(TAG, "  Finished Retaining: " + this);
2902707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                mRetaining = false;
2912707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                if (mStarted != mRetainingStarted) {
2922707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                    if (!mStarted) {
2932707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                        // This loader was retained in a started state, but
2942707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                        // at the end of retaining everything our owner is
2952707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                        // no longer started...  so make it stop.
2962707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                        stop();
2972707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                    }
2982707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                }
299c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn            }
300c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn
301afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn            if (mStarted && mHaveData && !mReportNextStart) {
302c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                // This loader has retained its data, either completely across
303c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                // a configuration change or just whatever the last data set
304c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                // was after being restarted from a stop, and now at the point of
305c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                // finishing the retain we find we remain started, have
306c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                // our data, and the owner has a new callback...  so
307c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                // let's deliver the data now.
308c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                callOnLoadFinished(mLoader, mData);
3092707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            }
3102707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
3112707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
312afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn        void reportStart() {
313afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn            if (mStarted) {
314afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                if (mReportNextStart) {
315afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                    mReportNextStart = false;
316afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                    if (mHaveData) {
317afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                        callOnLoadFinished(mLoader, mData);
318afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                    }
319afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                }
320afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn            }
321afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn        }
322afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn
3232707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        void stop() {
3245e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            if (DEBUG) Log.v(TAG, "  Stopping: " + this);
3252707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mStarted = false;
326debb2e25b3ce2f0f5195a2895dd1882fc172d4d8Dianne Hackborn            if (!mRetaining) {
327debb2e25b3ce2f0f5195a2895dd1882fc172d4d8Dianne Hackborn                if (mLoader != null && mListenerRegistered) {
328debb2e25b3ce2f0f5195a2895dd1882fc172d4d8Dianne Hackborn                    // Let the loader know we're done with it
329debb2e25b3ce2f0f5195a2895dd1882fc172d4d8Dianne Hackborn                    mListenerRegistered = false;
330debb2e25b3ce2f0f5195a2895dd1882fc172d4d8Dianne Hackborn                    mLoader.unregisterListener(this);
331debb2e25b3ce2f0f5195a2895dd1882fc172d4d8Dianne Hackborn                    mLoader.stopLoading();
332debb2e25b3ce2f0f5195a2895dd1882fc172d4d8Dianne Hackborn                }
3332707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            }
3342707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
3352707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
3362707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        void destroy() {
3375e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            if (DEBUG) Log.v(TAG, "  Destroying: " + this);
3382707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mDestroyed = true;
3396e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            boolean needReset = mDeliveredData;
3406e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            mDeliveredData = false;
3416e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            if (mCallbacks != null && mLoader != null && mHaveData && needReset) {
342a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                if (DEBUG) Log.v(TAG, "  Reseting: " + this);
343c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                String lastBecause = null;
344c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                if (mActivity != null) {
345c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                    lastBecause = mActivity.mFragments.mNoTransactionsBecause;
346c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                    mActivity.mFragments.mNoTransactionsBecause = "onLoaderReset";
347c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                }
348c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                try {
349c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                    mCallbacks.onLoaderReset(mLoader);
350c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                } finally {
351c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                    if (mActivity != null) {
352c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                        mActivity.mFragments.mNoTransactionsBecause = lastBecause;
353c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                    }
354c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                }
355c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn            }
3562707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mCallbacks = null;
357c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn            mData = null;
3586e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            mHaveData = false;
3592707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            if (mLoader != null) {
3602707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                if (mListenerRegistered) {
3612707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                    mListenerRegistered = false;
3622707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                    mLoader.unregisterListener(this);
3632707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                }
364c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn                mLoader.reset();
3652707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            }
3666e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            if (mPendingLoader != null) {
3676e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                mPendingLoader.destroy();
3686e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            }
3692707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
370c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
371c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        @Override public void onLoadComplete(Loader<Object> loader, Object data) {
372a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            if (DEBUG) Log.v(TAG, "onLoadComplete: " + this);
3736e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
3742707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            if (mDestroyed) {
375a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                if (DEBUG) Log.v(TAG, "  Ignoring load complete -- destroyed");
3762707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                return;
3772707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            }
3786e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
3796e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            if (mLoaders.get(mId) != this) {
3806e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                // This data is not coming from the current active loader.
3816e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                // We don't care about it.
3826e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                if (DEBUG) Log.v(TAG, "  Ignoring load complete -- not active");
3836e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                return;
3846e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            }
3856e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
3866e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            LoaderInfo pending = mPendingLoader;
3876e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            if (pending != null) {
3886e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                // There is a new request pending and we were just
3896e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                // waiting for the old one to complete before starting
3906e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                // it.  So now it is time, switch over to the new loader.
3916e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                if (DEBUG) Log.v(TAG, "  Switching to pending loader: " + pending);
3926e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                mPendingLoader = null;
3936e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                mLoaders.put(mId, null);
3946e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                destroy();
3956e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                installLoader(pending);
3966e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                return;
3976e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            }
3982707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
399c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn            // Notify of the new data so the app can switch out the old data before
400c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn            // we try to destroy it.
4016e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            if (mData != data || !mHaveData) {
4020e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn                mData = data;
4036e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                mHaveData = true;
4040e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn                if (mStarted) {
4050e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn                    callOnLoadFinished(loader, data);
4060e3b8f421dfcc5363f234eb1b76479cb2fb2e8eeDianne Hackborn                }
407c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn            }
408c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
409a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            //if (DEBUG) Log.v(TAG, "  onLoadFinished returned: " + this);
4105e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
4115e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            // We have now given the application the new loader with its
4125e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            // loaded data, so it should have stopped using the previous
4135e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            // loader.  If there is a previous loader on the inactive list,
4145e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            // clean it up.
4152707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            LoaderInfo info = mInactiveLoaders.get(mId);
4165e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            if (info != null && info != this) {
4176e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                info.mDeliveredData = false;
4185e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                info.destroy();
4192707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                mInactiveLoaders.remove(mId);
420c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn            }
421c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        }
4225e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
423fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        void callOnLoadFinished(Loader<Object> loader, Object data) {
424fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            if (mCallbacks != null) {
425fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                String lastBecause = null;
426fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                if (mActivity != null) {
427fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                    lastBecause = mActivity.mFragments.mNoTransactionsBecause;
428fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                    mActivity.mFragments.mNoTransactionsBecause = "onLoadFinished";
429fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                }
430fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                try {
431a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                    if (DEBUG) Log.v(TAG, "  onLoadFinished in " + loader + ": "
432a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                            + loader.dataToString(data));
433fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                    mCallbacks.onLoadFinished(loader, data);
434fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                } finally {
435fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                    if (mActivity != null) {
436fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                        mActivity.mFragments.mNoTransactionsBecause = lastBecause;
437fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                    }
438fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn                }
4396e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                mDeliveredData = true;
440fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            }
441fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        }
442fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn
4435e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn        @Override
4445e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn        public String toString() {
4455e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            StringBuilder sb = new StringBuilder(64);
4465e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            sb.append("LoaderInfo{");
4475e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            sb.append(Integer.toHexString(System.identityHashCode(this)));
4485e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            sb.append(" #");
4495e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            sb.append(mId);
450a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            sb.append(" : ");
451a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            DebugUtils.buildShortClassTag(mLoader, sb);
452a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            sb.append("}}");
45330d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            return sb.toString();
45430d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn        }
45530d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn
45630d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn        public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) {
45730d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            writer.print(prefix); writer.print("mId="); writer.print(mId);
45830d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn                    writer.print(" mArgs="); writer.println(mArgs);
45930d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            writer.print(prefix); writer.print("mCallbacks="); writer.println(mCallbacks);
46030d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            writer.print(prefix); writer.print("mLoader="); writer.println(mLoader);
461a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            if (mLoader != null) {
462a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                mLoader.dump(prefix + "  ", fd, writer, args);
463a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            }
4646e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            if (mHaveData || mDeliveredData) {
4656e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                writer.print(prefix); writer.print("mHaveData="); writer.print(mHaveData);
4666e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        writer.print("  mDeliveredData="); writer.println(mDeliveredData);
4676e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                writer.print(prefix); writer.print("mData="); writer.println(mData);
4686e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            }
46930d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            writer.print(prefix); writer.print("mStarted="); writer.print(mStarted);
470afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                    writer.print(" mReportNextStart="); writer.print(mReportNextStart);
471f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn                    writer.print(" mDestroyed="); writer.println(mDestroyed);
472afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn            writer.print(prefix); writer.print("mRetaining="); writer.print(mRetaining);
473afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                    writer.print(" mRetainingStarted="); writer.print(mRetainingStarted);
474afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn                    writer.print(" mListenerRegistered="); writer.println(mListenerRegistered);
4756e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            if (mPendingLoader != null) {
4766e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                writer.print(prefix); writer.println("Pending Loader ");
4776e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        writer.print(mPendingLoader); writer.println(":");
4786e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                mPendingLoader.dump(prefix + "  ", fd, writer, args);
4796e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            }
48030d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn        }
481c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
482c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
483fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn    LoaderManagerImpl(Activity activity, boolean started) {
484fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        mActivity = activity;
485c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        mStarted = started;
486c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
487c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
488fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn    void updateActivity(Activity activity) {
489fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        mActivity = activity;
490fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn    }
491fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn
4922707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    private LoaderInfo createLoader(int id, Bundle args,
4932707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            LoaderManager.LoaderCallbacks<Object> callback) {
4942707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        LoaderInfo info = new LoaderInfo(id, args,  (LoaderManager.LoaderCallbacks<Object>)callback);
4952707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        Loader<Object> loader = callback.onCreateLoader(id, args);
4962707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        info.mLoader = (Loader<Object>)loader;
4976e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        return info;
4986e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    }
4996e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
5006e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    private LoaderInfo createAndInstallLoader(int id, Bundle args,
5016e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            LoaderManager.LoaderCallbacks<Object> callback) {
5026e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        try {
5036e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            mCreatingLoader = true;
5046e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            LoaderInfo info = createLoader(id, args, callback);
5056e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            installLoader(info);
5066e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            return info;
5076e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        } finally {
5086e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            mCreatingLoader = false;
5096e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        }
5106e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    }
5116e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
5126e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    void installLoader(LoaderInfo info) {
5136e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        mLoaders.put(info.mId, info);
5142707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        if (mStarted) {
5154911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            // The activity will start all existing loaders in it's onStart(),
5164911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            // so only start them here if we're past that point of the activitiy's
5174911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            // life cycle
5184911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            info.start();
5192707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
5202707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    }
5212707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
5226e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    /**
5236e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * Call to initialize a particular ID with a Loader.  If this ID already
5246e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * has a Loader associated with it, it is left unchanged and any previous
5256e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * callbacks replaced with the newly provided ones.  If there is not currently
5266e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * a Loader for the ID, a new one is created and started.
5276e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     *
5286e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * <p>This function should generally be used when a component is initializing,
5296e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * to ensure that a Loader it relies on is created.  This allows it to re-use
5306e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * an existing Loader's data if there already is one, so that for example
5316e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * when an {@link Activity} is re-created after a configuration change it
5326e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * does not need to re-create its loaders.
5336e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     *
5346e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * <p>Note that in the case where an existing Loader is re-used, the
5356e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * <var>args</var> given here <em>will be ignored</em> because you will
5366e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * continue using the previous Loader.
5376e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     *
5386e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * @param id A unique (to this LoaderManager instance) identifier under
5396e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * which to manage the new Loader.
5406e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * @param args Optional arguments that will be propagated to
5416e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * {@link LoaderCallbacks#onCreateLoader(int, Bundle) LoaderCallbacks.onCreateLoader()}.
5426e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * @param callback Interface implementing management of this Loader.  Required.
5436e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * Its onCreateLoader() method will be called while inside of the function to
5446e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * instantiate the Loader object.
5456e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     */
5462707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    @SuppressWarnings("unchecked")
5472707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    public <D> Loader<D> initLoader(int id, Bundle args, LoaderManager.LoaderCallbacks<D> callback) {
5486e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        if (mCreatingLoader) {
5496e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            throw new IllegalStateException("Called while creating a loader");
5506e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        }
5516e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
5522707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        LoaderInfo info = mLoaders.get(id);
5532707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
554a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        if (DEBUG) Log.v(TAG, "initLoader in " + this + ": args=" + args);
5555e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
5562707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        if (info == null) {
5572707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            // Loader doesn't already exist; create.
5586e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            info = createAndInstallLoader(id, args,  (LoaderManager.LoaderCallbacks<Object>)callback);
559a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            if (DEBUG) Log.v(TAG, "  Created new loader " + info);
5602707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        } else {
561a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            if (DEBUG) Log.v(TAG, "  Re-using existing loader " + info);
5622707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            info.mCallbacks = (LoaderManager.LoaderCallbacks<Object>)callback;
5632707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
5642707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
5656e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        if (info.mHaveData && mStarted) {
5662707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            // If the loader has already generated its data, report it now.
567fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            info.callOnLoadFinished(info.mLoader, info.mData);
5682707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
5692707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
5702707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        return (Loader<D>)info.mLoader;
5712707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    }
5722707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
5736e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    /**
5746e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * Call to re-create the Loader associated with a particular ID.  If there
5756e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * is currently a Loader associated with this ID, it will be
5766e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * canceled/stopped/destroyed as appropriate.  A new Loader with the given
5776e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * arguments will be created and its data delivered to you once available.
5786e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     *
5796e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * <p>This function does some throttling of Loaders.  If too many Loaders
5806e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * have been created for the given ID but not yet generated their data,
5816e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * new calls to this function will create and return a new Loader but not
5826e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * actually start it until some previous loaders have completed.
5836e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     *
5846e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * <p>After calling this function, any previous Loaders associated with
5856e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * this ID will be considered invalid, and you will receive no further
5866e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * data updates from them.
5876e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     *
5886e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * @param id A unique (to this LoaderManager instance) identifier under
5896e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * which to manage the new Loader.
5906e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * @param args Optional arguments that will be propagated to
5916e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * {@link LoaderCallbacks#onCreateLoader(int, Bundle) LoaderCallbacks.onCreateLoader()}.
5926e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * @param callback Interface implementing management of this Loader.  Required.
5936e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * Its onCreateLoader() method will be called while inside of the function to
5946e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * instantiate the Loader object.
5956e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     */
596c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    @SuppressWarnings("unchecked")
5972707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    public <D> Loader<D> restartLoader(int id, Bundle args, LoaderManager.LoaderCallbacks<D> callback) {
5986e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        if (mCreatingLoader) {
5996e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            throw new IllegalStateException("Called while creating a loader");
6006e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        }
6016e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
602c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        LoaderInfo info = mLoaders.get(id);
603a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        if (DEBUG) Log.v(TAG, "restartLoader in " + this + ": args=" + args);
604c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        if (info != null) {
6055e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            LoaderInfo inactive = mInactiveLoaders.get(id);
6065e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn            if (inactive != null) {
6076e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                if (info.mHaveData) {
6085e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                    // This loader now has data...  we are probably being
6095e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                    // called from within onLoadComplete, where we haven't
6105e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                    // yet destroyed the last inactive loader.  So just do
6115e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                    // that now.
612a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                    if (DEBUG) Log.v(TAG, "  Removing last inactive loader: " + info);
6136e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                    inactive.mDeliveredData = false;
6145e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                    inactive.destroy();
615260c3c77d9b340164e055f87002c64d78da6e836Dianne Hackborn                    info.mLoader.abandon();
6165e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                    mInactiveLoaders.put(id, info);
6175e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                } else {
6185e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                    // We already have an inactive loader for this ID that we are
6196e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                    // waiting for!  What to do, what to do...
6206e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                    if (!info.mStarted) {
6216e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        // The current Loader has not been started...  we thus
6226e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        // have no reason to keep it around, so bam, slam,
6236e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        // thank-you-ma'am.
6246e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        if (DEBUG) Log.v(TAG, "  Current loader is stopped; replacing");
6256e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        mLoaders.put(id, null);
6266e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        info.destroy();
6276e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                    } else {
6286e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        // Now we have three active loaders... we'll queue
6296e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        // up this request to be processed once one of the other loaders
6306e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        // finishes.
6316e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        if (info.mPendingLoader != null) {
6326e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                            if (DEBUG) Log.v(TAG, "  Removing pending loader: " + info.mPendingLoader);
6336e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                            info.mPendingLoader.destroy();
6346e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                            info.mPendingLoader = null;
6356e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        }
6366e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        if (DEBUG) Log.v(TAG, "  Enqueuing as new pending loader");
6376e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        info.mPendingLoader = createLoader(id, args,
6386e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                                (LoaderManager.LoaderCallbacks<Object>)callback);
6396e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                        return (Loader<D>)info.mPendingLoader.mLoader;
6406e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                    }
6415e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn                }
6422707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            } else {
6432707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                // Keep track of the previous instance of this loader so we can destroy
6442707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                // it when the new one completes.
645a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                if (DEBUG) Log.v(TAG, "  Making last loader inactive: " + info);
646260c3c77d9b340164e055f87002c64d78da6e836Dianne Hackborn                info.mLoader.abandon();
6472707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                mInactiveLoaders.put(id, info);
6482707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            }
649c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        }
650c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
6516e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        info = createAndInstallLoader(id, args,  (LoaderManager.LoaderCallbacks<Object>)callback);
6522707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        return (Loader<D>)info.mLoader;
653c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
654c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
6556e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    /**
6566e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * Rip down, tear apart, shred to pieces a current Loader ID.  After returning
6576e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * from this function, any Loader objects associated with this ID are
6586e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * destroyed.  Any data associated with them is destroyed.  You better not
6596e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * be using it when you do this.
6606e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * @param id Identifier of the Loader to be destroyed.
6616e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     */
662c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn    public void destroyLoader(int id) {
6636e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        if (mCreatingLoader) {
6646e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            throw new IllegalStateException("Called while creating a loader");
6656e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        }
6666e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
667a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        if (DEBUG) Log.v(TAG, "destroyLoader in " + this + " of " + id);
6682707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        int idx = mLoaders.indexOfKey(id);
6692707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        if (idx >= 0) {
6702707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            LoaderInfo info = mLoaders.valueAt(idx);
6712707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mLoaders.removeAt(idx);
6724911b783aa9f4af5ac919db861751d350471f5efDianne Hackborn            info.destroy();
673c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        }
674f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn        idx = mInactiveLoaders.indexOfKey(id);
675f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn        if (idx >= 0) {
676f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn            LoaderInfo info = mInactiveLoaders.valueAt(idx);
677f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn            mInactiveLoaders.removeAt(idx);
678f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn            info.destroy();
679f73c75ca20fcaaee1b0eeaaf756252c33e3099c6Dianne Hackborn        }
680c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
681c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
6826e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn    /**
6836e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * Return the most recent Loader object associated with the
6846e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     * given ID.
6856e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn     */
686c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    @SuppressWarnings("unchecked")
687c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    public <D> Loader<D> getLoader(int id) {
6886e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        if (mCreatingLoader) {
6896e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            throw new IllegalStateException("Called while creating a loader");
6906e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn        }
6916e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn
692c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        LoaderInfo loaderInfo = mLoaders.get(id);
693c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        if (loaderInfo != null) {
6946e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            if (loaderInfo.mPendingLoader != null) {
6956e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn                return (Loader<D>)loaderInfo.mPendingLoader.mLoader;
6966e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            }
6976e1bf6a3054674281bafd270165c99cb2423666dDianne Hackborn            return (Loader<D>)loaderInfo.mLoader;
698c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        }
699c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        return null;
700c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
701c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
702c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    void doStart() {
703a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        if (DEBUG) Log.v(TAG, "Starting in " + this);
704fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        if (mStarted) {
705fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            RuntimeException e = new RuntimeException("here");
706fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            e.fillInStackTrace();
707fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            Log.w(TAG, "Called doStart when already started: " + this, e);
708fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            return;
709fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        }
710fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn
711c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn        mStarted = true;
712c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn
713c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        // Call out to sub classes so they can start their loaders
714c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        // Let the existing loaders know that we want to be notified when a load is complete
715c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        for (int i = mLoaders.size()-1; i >= 0; i--) {
7162707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mLoaders.valueAt(i).start();
717c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        }
718c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
719c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
720c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    void doStop() {
721a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        if (DEBUG) Log.v(TAG, "Stopping in " + this);
722fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        if (!mStarted) {
723fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            RuntimeException e = new RuntimeException("here");
724fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            e.fillInStackTrace();
725fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            Log.w(TAG, "Called doStop when not started: " + this, e);
726fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            return;
727fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        }
7285e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
729c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        for (int i = mLoaders.size()-1; i >= 0; i--) {
7302707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mLoaders.valueAt(i).stop();
731c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        }
732c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        mStarted = false;
733c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
734c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn
7352707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    void doRetain() {
736a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        if (DEBUG) Log.v(TAG, "Retaining in " + this);
737fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        if (!mStarted) {
738fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            RuntimeException e = new RuntimeException("here");
739fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            e.fillInStackTrace();
740fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            Log.w(TAG, "Called doRetain when not started: " + this, e);
741fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn            return;
742fb3cffeb35368da22f99b85d45039c4e6e471c06Dianne Hackborn        }
7435e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
7442707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        mRetaining = true;
7452707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        mStarted = false;
7462707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        for (int i = mLoaders.size()-1; i >= 0; i--) {
7472707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mLoaders.valueAt(i).retain();
7482707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
7492707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    }
7502707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
7512707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    void finishRetain() {
752a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        if (mRetaining) {
753a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            if (DEBUG) Log.v(TAG, "Finished Retaining in " + this);
7545e0d59547c4042037e23a42ba4e2521721e9c7d3Dianne Hackborn
755a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            mRetaining = false;
756a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            for (int i = mLoaders.size()-1; i >= 0; i--) {
757a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                mLoaders.valueAt(i).finishRetain();
758a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            }
7592707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
7602707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn    }
7612707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
762afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn    void doReportNextStart() {
763afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn        for (int i = mLoaders.size()-1; i >= 0; i--) {
764afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn            mLoaders.valueAt(i).mReportNextStart = true;
765afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn        }
766afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn    }
767afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn
768afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn    void doReportStart() {
769afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn        for (int i = mLoaders.size()-1; i >= 0; i--) {
770afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn            mLoaders.valueAt(i).reportStart();
771afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn        }
772afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn    }
773afc4b283fdaedec9bf32492a019b43cc33edc9b6Dianne Hackborn
774c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    void doDestroy() {
7752707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        if (!mRetaining) {
776a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn            if (DEBUG) Log.v(TAG, "Destroying Active in " + this);
777c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn            for (int i = mLoaders.size()-1; i >= 0; i--) {
7782707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn                mLoaders.valueAt(i).destroy();
779c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn            }
780c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn        }
7812707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn
782a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        if (DEBUG) Log.v(TAG, "Destroying Inactive in " + this);
7832707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        for (int i = mInactiveLoaders.size()-1; i >= 0; i--) {
7842707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn            mInactiveLoaders.valueAt(i).destroy();
7852707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        }
7862707d6026240bcca6f0e35e2e1138958882e90ceDianne Hackborn        mInactiveLoaders.clear();
787c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn    }
78830d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn
78930d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn    @Override
790a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn    public String toString() {
791a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        StringBuilder sb = new StringBuilder(128);
792a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        sb.append("LoaderManager{");
793a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        sb.append(Integer.toHexString(System.identityHashCode(this)));
794a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        sb.append(" in ");
795a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        DebugUtils.buildShortClassTag(mActivity, sb);
796a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        sb.append("}}");
797a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn        return sb.toString();
798a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn    }
799a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn
800a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn    @Override
80130d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn    public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) {
80230d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn        if (mLoaders.size() > 0) {
80330d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            writer.print(prefix); writer.println("Active Loaders:");
80430d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            String innerPrefix = prefix + "    ";
80530d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            for (int i=0; i < mLoaders.size(); i++) {
80630d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn                LoaderInfo li = mLoaders.valueAt(i);
80730d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn                writer.print(prefix); writer.print("  #"); writer.print(mLoaders.keyAt(i));
808a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                        writer.print(": "); writer.println(li.toString());
80930d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn                li.dump(innerPrefix, fd, writer, args);
81030d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            }
81130d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn        }
81230d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn        if (mInactiveLoaders.size() > 0) {
81330d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            writer.print(prefix); writer.println("Inactive Loaders:");
81430d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            String innerPrefix = prefix + "    ";
81530d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            for (int i=0; i < mInactiveLoaders.size(); i++) {
81630d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn                LoaderInfo li = mInactiveLoaders.valueAt(i);
81730d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn                writer.print(prefix); writer.print("  #"); writer.print(mInactiveLoaders.keyAt(i));
818a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn                        writer.print(": "); writer.println(li.toString());
81930d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn                li.dump(innerPrefix, fd, writer, args);
82030d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn            }
82130d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn        }
82230d7189067524000c738c188c4ff91f84f474d25Dianne Hackborn    }
823c801768e4d29667a2608695449ebc2833ba0f200Dianne Hackborn}
824