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

Commit 6a6cdafa authored by Jeff Sharkey's avatar Jeff Sharkey
Browse files

APIs to obtain SharedPreferences paths. 

Needed for apps that want to migrate SharedPreferences from CE to DE
storage.  Note that a device will only ever enter a CE mode with a
factory reset, so apps should only be using these APIs when they
want to migrate files to a consistent location on non-FBE devices
for simplicity.

Bug: 25503089
Change-Id: Ic846215da1617d116a048e036415ac7ad523b770
parent ce14cd01

api/current.txt

+4 −0
Original line number Diff line number Diff line
@@ -7823,6 +7823,7 @@ package android.content { 
    method public abstract android.content.res.Resources getResources();

    method public abstract android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public abstract android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public abstract java.io.File getSharedPreferencesPath(java.lang.String);

    method public final java.lang.String getString(int);

    method public final java.lang.String getString(int, java.lang.Object...);

    method public abstract java.lang.Object getSystemService(java.lang.String);
@@ -8007,6 +8008,7 @@ package android.content { 
    method public android.content.res.Resources getResources();

    method public android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public java.io.File getSharedPreferencesPath(java.lang.String);

    method public java.lang.Object getSystemService(java.lang.String);

    method public java.lang.String getSystemServiceName(java.lang.Class<?>);

    method public android.content.res.Resources.Theme getTheme();
@@ -28468,6 +28470,7 @@ package android.preference { 
    method public android.preference.PreferenceScreen createPreferenceScreen(android.content.Context);

    method public android.preference.Preference findPreference(java.lang.CharSequence);

    method public static android.content.SharedPreferences getDefaultSharedPreferences(android.content.Context);

    method public static java.lang.String getDefaultSharedPreferencesName(android.content.Context);

    method public android.content.SharedPreferences getSharedPreferences();

    method public int getSharedPreferencesMode();

    method public java.lang.String getSharedPreferencesName();
@@ -36272,6 +36275,7 @@ package android.test.mock { 
    method public android.content.res.Resources getResources();

    method public android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public java.io.File getSharedPreferencesPath(java.lang.String);

    method public java.lang.Object getSystemService(java.lang.String);

    method public java.lang.String getSystemServiceName(java.lang.Class<?>);

    method public android.content.res.Resources.Theme getTheme();

api/system-current.txt

+4 −0
Original line number Diff line number Diff line
@@ -8068,6 +8068,7 @@ package android.content { 
    method public abstract android.content.res.Resources getResources();

    method public abstract android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public abstract android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public abstract java.io.File getSharedPreferencesPath(java.lang.String);

    method public final java.lang.String getString(int);

    method public final java.lang.String getString(int, java.lang.Object...);

    method public abstract java.lang.Object getSystemService(java.lang.String);
@@ -8261,6 +8262,7 @@ package android.content { 
    method public android.content.res.Resources getResources();

    method public android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public java.io.File getSharedPreferencesPath(java.lang.String);

    method public java.lang.Object getSystemService(java.lang.String);

    method public java.lang.String getSystemServiceName(java.lang.Class<?>);

    method public android.content.res.Resources.Theme getTheme();
@@ -30461,6 +30463,7 @@ package android.preference { 
    method public android.preference.PreferenceScreen createPreferenceScreen(android.content.Context);

    method public android.preference.Preference findPreference(java.lang.CharSequence);

    method public static android.content.SharedPreferences getDefaultSharedPreferences(android.content.Context);

    method public static java.lang.String getDefaultSharedPreferencesName(android.content.Context);

    method public android.content.SharedPreferences getSharedPreferences();

    method public int getSharedPreferencesMode();

    method public java.lang.String getSharedPreferencesName();
@@ -38599,6 +38602,7 @@ package android.test.mock { 
    method public android.content.res.Resources getResources();

    method public android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public java.io.File getSharedPreferencesPath(java.lang.String);

    method public java.lang.Object getSystemService(java.lang.String);

    method public java.lang.String getSystemServiceName(java.lang.Class<?>);

    method public android.content.res.Resources.Theme getTheme();

api/test-current.txt

+4 −0
Original line number Diff line number Diff line
@@ -7823,6 +7823,7 @@ package android.content { 
    method public abstract android.content.res.Resources getResources();

    method public abstract android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public abstract android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public abstract java.io.File getSharedPreferencesPath(java.lang.String);

    method public final java.lang.String getString(int);

    method public final java.lang.String getString(int, java.lang.Object...);

    method public abstract java.lang.Object getSystemService(java.lang.String);
@@ -8007,6 +8008,7 @@ package android.content { 
    method public android.content.res.Resources getResources();

    method public android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public java.io.File getSharedPreferencesPath(java.lang.String);

    method public java.lang.Object getSystemService(java.lang.String);

    method public java.lang.String getSystemServiceName(java.lang.Class<?>);

    method public android.content.res.Resources.Theme getTheme();
@@ -28468,6 +28470,7 @@ package android.preference { 
    method public android.preference.PreferenceScreen createPreferenceScreen(android.content.Context);

    method public android.preference.Preference findPreference(java.lang.CharSequence);

    method public static android.content.SharedPreferences getDefaultSharedPreferences(android.content.Context);

    method public static java.lang.String getDefaultSharedPreferencesName(android.content.Context);

    method public android.content.SharedPreferences getSharedPreferences();

    method public int getSharedPreferencesMode();

    method public java.lang.String getSharedPreferencesName();
@@ -36274,6 +36277,7 @@ package android.test.mock { 
    method public android.content.res.Resources getResources();

    method public android.content.SharedPreferences getSharedPreferences(java.lang.String, int);

    method public android.content.SharedPreferences getSharedPreferences(java.io.File, int);

    method public java.io.File getSharedPreferencesPath(java.lang.String);

    method public java.lang.Object getSystemService(java.lang.String);

    method public java.lang.String getSystemServiceName(java.lang.Class<?>);

    method public android.content.res.Resources.Theme getTheme();

core/java/android/app/ContextImpl.java

+6 −6
Original line number Diff line number Diff line
@@ -320,11 +320,6 @@ class ContextImpl extends Context { 
        throw new RuntimeException("Not supported in system context");

    }



    @Override

    public File getSharedPrefsFile(String name) {

        return makeFilename(getPreferencesDir(), name + ".xml");

    }



    @Override

    public SharedPreferences getSharedPreferences(String name, int mode) {

        // At least one application in the world actually passes in a null
@@ -337,7 +332,7 @@ class ContextImpl extends Context { 
            }

        }



        final File file = getSharedPrefsFile(name);

        final File file = getSharedPreferencesPath(name);

        return getSharedPreferences(file, mode);

    }
@@ -570,6 +565,11 @@ class ContextImpl extends Context { 
        return makeFilename(getFilesDir(), name);

    }



    @Override

    public File getSharedPreferencesPath(String name) {

        return makeFilename(getPreferencesDir(), name + ".xml");

    }



    @Override

    public String[] fileList() {

        final String[] list = getFilesDir().list();

core/java/android/content/Context.java

+21 −6
Original line number Diff line number Diff line
@@ -606,13 +606,13 @@ public abstract class Context { 
    public abstract String getPackageCodePath();



    /**

     * {@hide}

     * Return the full path to the shared prefs file for the given prefs group name.

     *

     * <p>Note: this is not generally useful for applications, since they should

     * not be directly accessing the file system.

     * @hide

     * @deprecated use {@link #getSharedPreferencesPath(String)}

     */

    public abstract File getSharedPrefsFile(String name);

    @Deprecated

    public File getSharedPrefsFile(String name) {

        return getSharedPreferencesPath(name);

    }



    /**

     * Retrieve and hold the contents of the preferences file 'name', returning
@@ -654,6 +654,7 @@ public abstract class Context { 
     * @return The single {@link SharedPreferences} instance that can be used

     *         to retrieve and modify the preference values.

     *

     * @see #getSharedPreferencesPath(String)

     * @see #MODE_PRIVATE

     * @see #MODE_WORLD_READABLE

     * @see #MODE_WORLD_WRITEABLE
@@ -738,6 +739,20 @@ public abstract class Context { 
     */

    public abstract File getFileStreamPath(String name);



    /**

     * Returns the absolute path on the filesystem where a file created with

     * {@link #getSharedPreferences(String, int)} is stored.

     * <p>

     * The returned path may change over time if the calling app is moved to an

     * adopted storage device, so only relative paths should be persisted.

     *

     * @param name The name of the shared preferences for which you would like

     *            to get a path.

     * @return An absolute path to the given file.

     * @see #getSharedPreferences(String, int)

     */

    public abstract File getSharedPreferencesPath(String name);



    /**

     * Returns the absolute path to the directory on the filesystem where files

     * created with {@link #openFileOutput} are stored.