From e1db351bfb9ee89a0333113b1c44c57c537f9eb1 Mon Sep 17 00:00:00 2001 From: Antony Sargent Date: Tue, 8 Feb 2022 20:11:30 -0800 Subject: [PATCH] Rename LOCK_STATE_ALWAYS_LOCKED to LOCK_STATE_DEFAULT Also update the documentation to more accurately represent what the flag actually does. Bug: 217273933 Test: existing tests should pass Change-Id: I28c9798d7974e58cfcd6ab59e7ee50f9a6c43985 --- core/api/system-current.txt | 2 +- .../companion/virtual/VirtualDeviceParams.java | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/core/api/system-current.txt b/core/api/system-current.txt index 02f05d255eb8f..ba0d3cf684e19 100644 --- a/core/api/system-current.txt +++ b/core/api/system-current.txt @@ -2772,8 +2772,8 @@ package android.companion.virtual { method @NonNull public java.util.Set getUsersWithMatchingAccounts(); method public void writeToParcel(@NonNull android.os.Parcel, int); field @NonNull public static final android.os.Parcelable.Creator CREATOR; - field public static final int LOCK_STATE_ALWAYS_LOCKED = 0; // 0x0 field public static final int LOCK_STATE_ALWAYS_UNLOCKED = 1; // 0x1 + field public static final int LOCK_STATE_DEFAULT = 0; // 0x0 } public static final class VirtualDeviceParams.Builder { diff --git a/core/java/android/companion/virtual/VirtualDeviceParams.java b/core/java/android/companion/virtual/VirtualDeviceParams.java index 1d0f7c0918070..45d0ad51da049 100644 --- a/core/java/android/companion/virtual/VirtualDeviceParams.java +++ b/core/java/android/companion/virtual/VirtualDeviceParams.java @@ -48,15 +48,16 @@ public final class VirtualDeviceParams implements Parcelable { /** @hide */ @IntDef(prefix = "LOCK_STATE_", - value = {LOCK_STATE_ALWAYS_LOCKED, LOCK_STATE_ALWAYS_UNLOCKED}) + value = {LOCK_STATE_DEFAULT, LOCK_STATE_ALWAYS_UNLOCKED}) @Retention(RetentionPolicy.SOURCE) @Target({ElementType.TYPE_PARAMETER, ElementType.TYPE_USE}) public @interface LockState {} /** - * Indicates that the lock state of the virtual device should be always locked. + * Indicates that the lock state of the virtual device will be the same as the default physical + * display. */ - public static final int LOCK_STATE_ALWAYS_LOCKED = 0; + public static final int LOCK_STATE_DEFAULT = 0; /** * Indicates that the lock state of the virtual device should be always unlocked. @@ -199,7 +200,7 @@ public final class VirtualDeviceParams implements Parcelable { */ public static final class Builder { - private @LockState int mLockState = LOCK_STATE_ALWAYS_LOCKED; + private @LockState int mLockState = LOCK_STATE_DEFAULT; private Set mUsersWithMatchingAccounts; @Nullable private Set mBlockedActivities; @Nullable private Set mAllowedActivities; @@ -207,9 +208,9 @@ public final class VirtualDeviceParams implements Parcelable { /** * Sets the lock state of the device. The permission {@code ADD_ALWAYS_UNLOCKED_DISPLAY} * is required if this is set to {@link #LOCK_STATE_ALWAYS_UNLOCKED}. - * The default is {@link #LOCK_STATE_ALWAYS_LOCKED}. + * The default is {@link #LOCK_STATE_DEFAULT}. * - * @param lockState The lock state, either {@link #LOCK_STATE_ALWAYS_LOCKED} or + * @param lockState The lock state, either {@link #LOCK_STATE_DEFAULT} or * {@link #LOCK_STATE_ALWAYS_UNLOCKED}. */ @RequiresPermission(value = ADD_ALWAYS_UNLOCKED_DISPLAY, conditional = true)