From 0bbb9f68824092f210a205253c27ab4c2eefb762 Mon Sep 17 00:00:00 2001 From: Abhijeet Kaur Date: Fri, 8 Mar 2019 11:00:29 +0000 Subject: Clean up bugreport API. Make BugreportManager class final. Add FloatRange annotation for BugreportManager.onProgress() function's parameter. Make @IntDef in BugreportMode hidden. Bug: 126434607 Test: builds Change-Id: I95f004106ba97bc9e99859a8b23b96a86b6a43f4 Merged-In: I95f004106ba97bc9e99859a8b23b96a86b6a43f4 --- api/system-current.txt | 9 +++------ core/java/android/os/BugreportManager.java | 5 +++-- core/java/android/os/BugreportParams.java | 1 + 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/api/system-current.txt b/api/system-current.txt index b9378bbefbc9..568010b984d8 100644 --- a/api/system-current.txt +++ b/api/system-current.txt @@ -4012,7 +4012,7 @@ package android.os { field public static final String EXTRA_EVENT_TIMESTAMP = "android.os.extra.EVENT_TIMESTAMP"; } - public class BugreportManager { + public final class BugreportManager { method @RequiresPermission(android.Manifest.permission.DUMP) public void cancelBugreport(); method @RequiresPermission(android.Manifest.permission.DUMP) public void startBugreport(@NonNull android.os.ParcelFileDescriptor, @Nullable android.os.ParcelFileDescriptor, @NonNull android.os.BugreportParams, @NonNull java.util.concurrent.Executor, @NonNull android.os.BugreportManager.BugreportCallback); } @@ -4021,7 +4021,7 @@ package android.os { ctor public BugreportManager.BugreportCallback(); method public void onError(int); method public void onFinished(); - method public void onProgress(float); + method public void onProgress(@FloatRange(from=0.0f, to=100.0f) float); field public static final int BUGREPORT_ERROR_ANOTHER_REPORT_IN_PROGRESS = 5; // 0x5 field public static final int BUGREPORT_ERROR_INVALID_INPUT = 1; // 0x1 field public static final int BUGREPORT_ERROR_RUNTIME = 2; // 0x2 @@ -4030,7 +4030,7 @@ package android.os { } public final class BugreportParams { - ctor public BugreportParams(@android.os.BugreportParams.BugreportMode int); + ctor public BugreportParams(int); method public int getMode(); field public static final int BUGREPORT_MODE_FULL = 0; // 0x0 field public static final int BUGREPORT_MODE_INTERACTIVE = 1; // 0x1 @@ -4040,9 +4040,6 @@ package android.os { field public static final int BUGREPORT_MODE_WIFI = 5; // 0x5 } - @java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.SOURCE) @IntDef(prefix={"BUGREPORT_MODE_"}, value={android.os.BugreportParams.BUGREPORT_MODE_FULL, android.os.BugreportParams.BUGREPORT_MODE_INTERACTIVE, android.os.BugreportParams.BUGREPORT_MODE_REMOTE, android.os.BugreportParams.BUGREPORT_MODE_WEAR, android.os.BugreportParams.BUGREPORT_MODE_TELEPHONY, android.os.BugreportParams.BUGREPORT_MODE_WIFI}) public static @interface BugreportParams.BugreportMode { - } - public final class ConfigUpdate { field public static final String ACTION_UPDATE_CARRIER_ID_DB = "android.os.action.UPDATE_CARRIER_ID_DB"; field public static final String ACTION_UPDATE_CARRIER_PROVISIONING_URLS = "android.intent.action.UPDATE_CARRIER_PROVISIONING_URLS"; diff --git a/core/java/android/os/BugreportManager.java b/core/java/android/os/BugreportManager.java index 684369a6f720..672624cab88c 100644 --- a/core/java/android/os/BugreportManager.java +++ b/core/java/android/os/BugreportManager.java @@ -17,6 +17,7 @@ package android.os; import android.annotation.CallbackExecutor; +import android.annotation.FloatRange; import android.annotation.IntDef; import android.annotation.NonNull; import android.annotation.Nullable; @@ -39,7 +40,7 @@ import java.util.concurrent.Executor; */ @SystemApi @SystemService(Context.BUGREPORT_SERVICE) -public class BugreportManager { +public final class BugreportManager { private final Context mContext; private final IDumpstate mBinder; @@ -90,7 +91,7 @@ public class BugreportManager { * Called when there is a progress update. * @param progress the progress in [0.0, 100.0] */ - public void onProgress(float progress) {} + public void onProgress(@FloatRange(from = 0f, to = 100f) float progress) {} /** * Called when taking bugreport resulted in an error. diff --git a/core/java/android/os/BugreportParams.java b/core/java/android/os/BugreportParams.java index 3871375cfced..279ccae7c94f 100644 --- a/core/java/android/os/BugreportParams.java +++ b/core/java/android/os/BugreportParams.java @@ -41,6 +41,7 @@ public final class BugreportParams { /** * Defines acceptable types of bugreports. + * @hide */ @Retention(RetentionPolicy.SOURCE) @IntDef(prefix = { "BUGREPORT_MODE_" }, value = { -- cgit v1.2.3-59-g8ed1b