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

Commit 5272c377 authored by Nate Fischer's avatar Nate Fischer
Browse files

Docs: clarify getSharedPreferences behavior 

No change to logic, only documentation.

This updates Context#getSharedPreferences docs:

 * Fix a typo ("thead" -> "thread")
 * Formatting: use <p> when appropriate, {@link} to other APIs, limit
   the @param to only a single sentence
 * Mention getSharedPreferences() may actually perform disk IO (this was
   undocumented)
 * Mention Editor#apply() as well as #commit()

Fixes: 140137651
Test: make docs
Change-Id: I245371d13d4f317c6c522debcdf7938ab783f897
parent dd373761

core/java/android/content/Context.java

+9 −4
Original line number Diff line number Diff line
@@ -852,11 +852,16 @@ public abstract class Context { 
     * to any callers for the same name, meaning they will see each other's

     * edits as soon as they are made.

     *

     * This method is thead-safe.

     * <p>This method is thread-safe.

     *

     * @param name Desired preferences file. If a preferences file by this name

     * does not exist, it will be created when you retrieve an

     * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).

     * <p>If the preferences directory does not already exist, it will be created when this method

     * is called.

     *

     * <p>If a preferences file by this name does not exist, it will be created when you retrieve an

     * editor ({@link SharedPreferences#edit()}) and then commit changes ({@link

     * SharedPreferences.Editor#commit()} or {@link SharedPreferences.Editor#apply()}).

     *

     * @param name Desired preferences file.

     * @param mode Operating mode.

     *

     * @return The single {@link SharedPreferences} instance that can be used