summaryrefslogtreecommitdiff
path: root/core/java/android
diff options
context:
space:
mode:
authorTreehugger Robot <treehugger-gerrit@google.com>2021-10-07 14:29:04 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2021-10-07 14:29:04 +0000
commit509a70ea062d14ca560465443d26f8b7f62efbcb (patch)
treed36906ea0395bc394024d2757fb51a96106d2b29 /core/java/android
parentee05ff24d8533f0ede23af81dd721fb92551ba1c (diff)
parent9a2a261abda2f490a68bced4e8288599f8b0243e (diff)
Merge "Improve Bundle/PersistableBundle docs" am: 9a2a261abd
Original change: https://android-review.googlesource.com/c/platform/frameworks/base/+/1846255 Change-Id: I22cff9303a22273617bce75ddc361f59d4799e9d
Diffstat (limited to 'core/java/android')
-rw-r--r--core/java/android/os/Bundle.java7
-rw-r--r--core/java/android/os/PersistableBundle.java9
2 files changed, 15 insertions, 1 deletions
diff --git a/core/java/android/os/Bundle.java b/core/java/android/os/Bundle.java
index f215325f6be2..92eb7a5d047e 100644
--- a/core/java/android/os/Bundle.java
+++ b/core/java/android/os/Bundle.java
@@ -33,6 +33,9 @@ import java.util.List;
/**
* A mapping from String keys to various {@link Parcelable} values.
*
+ * <p><b>Warning:</b> Note that {@link Bundle} is a lazy container and as such it does NOT implement
+ * {@link #equals(Object)} or {@link #hashCode()}.
+ *
* @see PersistableBundle
*/
public final class Bundle extends BaseBundle implements Cloneable, Parcelable {
@@ -1230,6 +1233,10 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable {
maybePrefillHasFds();
}
+ /**
+ * Returns a string representation of the {@link Bundle} that may be suitable for debugging. It
+ * won't print the internal map if its content hasn't been unparcelled.
+ */
@Override
public synchronized String toString() {
if (mParcelledData != null) {
diff --git a/core/java/android/os/PersistableBundle.java b/core/java/android/os/PersistableBundle.java
index 76b88a3399d8..7b55e710caeb 100644
--- a/core/java/android/os/PersistableBundle.java
+++ b/core/java/android/os/PersistableBundle.java
@@ -43,6 +43,9 @@ import java.util.ArrayList;
* supported by this class is purposefully restricted to simple objects that can
* safely be persisted to and restored from disk.
*
+ * <p><b>Warning:</b> Note that {@link PersistableBundle} is a lazy container and as such it does
+ * NOT implement {@link #equals(Object)} or {@link #hashCode()}.
+ *
* @see Bundle
*/
public final class PersistableBundle extends BaseBundle implements Cloneable, Parcelable,
@@ -324,8 +327,12 @@ public final class PersistableBundle extends BaseBundle implements Cloneable, Pa
return new PersistableBundle(); // An empty mutable PersistableBundle
}
+ /**
+ * Returns a string representation of the {@link PersistableBundle} that may be suitable for
+ * debugging. It won't print the internal map if its content hasn't been unparcelled.
+ */
@Override
- synchronized public String toString() {
+ public synchronized String toString() {
if (mParcelledData != null) {
if (isEmptyParcel()) {
return "PersistableBundle[EMPTY_PARCEL]";