summaryrefslogtreecommitdiff
path: root/core/java/android/content/SharedPreferences.java
diff options
context:
space:
mode:
authorMark Lu <marklu@google.com>2016-08-02 12:10:30 -0700
committerMark Lu <marklu@google.com>2016-08-02 12:10:48 -0700
commitfb48521f41ef780bb305bf2f9819e7e018885197 (patch)
tree8ba93f2848057ad175f359edfb9e0e8bde98abaa /core/java/android/content/SharedPreferences.java
parent2b318b3a4e06f8b8f42ee3a49c82d70091017731 (diff)
docs: add info to SharedPreferences.Editor.putString
The information explains what happens when null is passed as value parameter Bug: 24696308 Change-Id: I362c2b1885e882312d1b4b2ff829f8f9f3546301
Diffstat (limited to 'core/java/android/content/SharedPreferences.java')
-rw-r--r--core/java/android/content/SharedPreferences.java4
1 files changed, 3 insertions, 1 deletions
diff --git a/core/java/android/content/SharedPreferences.java b/core/java/android/content/SharedPreferences.java
index 7f9e17641a19..4b09feda2173 100644
--- a/core/java/android/content/SharedPreferences.java
+++ b/core/java/android/content/SharedPreferences.java
@@ -72,7 +72,9 @@ public interface SharedPreferences {
* {@link #commit} or {@link #apply} are called.
*
* @param key The name of the preference to modify.
- * @param value The new value for the preference.
+ * @param value The new value for the preference. Passing {@code null}
+ * for this argument is equivalent to calling {@link #remove(String)} with
+ * this key.
*
* @return Returns a reference to the same Editor object, so you can
* chain put calls together.