summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Hunter Knepshield <hknepshield@google.com> 2021-02-26 19:12:00 +0000
committer Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> 2021-02-26 19:12:00 +0000
commit0f5e18a9f0df2257848d79b050e0eccc49d32e49 (patch)
treedc53cf9c2e74fa2e27ade91e370a521cd7a8985c
parent472f02851fc90c34529ab333d811c18507277ed6 (diff)
parentb79c80ba780d4fb98e91fc9f8e824dc7687ed170 (diff)
Merge "[API review] Additional detail in BugreportCallback javadoc." am: 39742a519c am: b79c80ba78
Original change: https://android-review.googlesource.com/c/platform/frameworks/base/+/1607112 MUST ONLY BE SUBMITTED BY AUTOMERGER Change-Id: I71f11a4a2ecec595a428f611d5bf62181a5e18d4
-rw-r--r--core/java/android/os/BugreportManager.java7
1 files changed, 5 insertions, 2 deletions
diff --git a/core/java/android/os/BugreportManager.java b/core/java/android/os/BugreportManager.java
index a435ac12d33c..73bb8d566500 100644
--- a/core/java/android/os/BugreportManager.java
+++ b/core/java/android/os/BugreportManager.java
@@ -68,8 +68,11 @@ public final class BugreportManager {
/**
* An interface describing the callback for bugreport progress and status.
*
- * <p>In general, callers can expect to receive {@link #onProgress} calls as the bugreport
- * progresses, followed by a terminal call to either {@link #onFinished} or {@link #onError}.
+ * <p>Callers will receive {@link #onProgress} calls as the bugreport progresses, followed by a
+ * terminal call to either {@link #onFinished} or {@link #onError}.
+ *
+ * <p>If an issue is encountered while starting the bugreport asynchronously, callers will
+ * receive an {@link #onError} call without any {@link #onProgress} callbacks.
*/
public abstract static class BugreportCallback {
/**