Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit dd644c17 authored by Brad Fitzpatrick's avatar Brad Fitzpatrick
Browse files

Fallback to SharedPreferences$Editor.commit() when no apply() exists. 

Gingerbread widened the SharedPreferences.Editor interface, adding an
apply() method.  Most people don't implement this interface
themselves, but a couple apps do.

A few spots in the core framework take a SharedPreferences[.Editor]
from apps, which might be a pre-Gingerbread implementation without an
apply() method.  This patch makes sure we never depend on the presence
of an apply() method, falling back to commit() if apply() isn't
available.

Change-Id: I32693ac9227a60b694526a26a30234fb17a40581
parent 4e1658af

core/java/android/content/SharedPreferences.java

+15 −3
Original line number Diff line number Diff line
@@ -186,9 +186,21 @@ public interface SharedPreferences { 
         * {@link #commit} will block until all async commits are

         * completed as well as the commit itself.

         *

         * <p>If you call this from an {@link android.app.Activity},

         * the base class will wait for any async commits to finish in

         * its {@link android.app.Activity#onPause}.</p>

         * <p>As {@link SharedPreferences} instances are singletons within

         * a process, it's safe to replace any instance of {@link #commit} with

         * {@link #apply} if you were already ignoring the return value.

         *

         * <p>You don't need to worry about Android component

         * lifecycles and their interaction with <code>apply()</code>

         * writing to disk.  The framework makes sure in-flight disk

         * writes from <code>apply()</code> complete before switching

         * states.

         *

         * <p class='note'>The SharedPreferences.Editor interface

         * isn't expected to be implemented directly.  However, if you

         * previously did implement it and are now getting errors

         * about missing <code>apply()</code>, you can simply call

         * {@link #commit} from <code>apply()</code>.

         */

        void apply();

    }

core/java/android/preference/Preference.java

+8 −1
Original line number Diff line number Diff line
@@ -1195,7 +1195,14 @@ public class Preference implements Comparable<Preference>, OnDependencyChangeLis 


    private void tryCommit(SharedPreferences.Editor editor) {

        if (mPreferenceManager.shouldCommit()) {

            try {

                editor.apply();

            } catch (AbstractMethodError unused) {

                // The app injected its own pre-Gingerbread

                // SharedPreferences.Editor implementation without

                // an apply method.

                editor.commit();

            }

        }

    }

core/java/android/preference/PreferenceManager.java

+20 −5
Original line number Diff line number Diff line
@@ -443,7 +443,16 @@ public class PreferenceManager { 
            pm.setSharedPreferencesMode(sharedPreferencesMode);

            pm.inflateFromResource(context, resId, null);



            defaultValueSp.edit().putBoolean(KEY_HAS_SET_DEFAULT_VALUES, true).apply();

            SharedPreferences.Editor editor =

                    defaultValueSp.edit().putBoolean(KEY_HAS_SET_DEFAULT_VALUES, true);

            try {

                editor.apply();

            } catch (AbstractMethodError unused) {

                // The app injected its own pre-Gingerbread

                // SharedPreferences.Editor implementation without

                // an apply method.

                editor.commit();

            }

        }

    }
@@ -481,9 +490,15 @@ public class PreferenceManager { 


    private void setNoCommit(boolean noCommit) {

        if (!noCommit && mEditor != null) {

            try {

                mEditor.apply();

            } catch (AbstractMethodError unused) {

                // The app injected its own pre-Gingerbread

                // SharedPreferences.Editor implementation without

                // an apply method.

                mEditor.commit();

            }

        }

        

        mNoCommit = noCommit;

    }