From c39b4fc6864db8c41261acaa54e0ac6d6a3a9bc1 Mon Sep 17 00:00:00 2001
From: Adrian Roos <roosa@google.com>
Date: Tue, 28 Apr 2015 15:48:00 -0700
Subject: [PATCH] Clarify javadoc of isKeyguardSecure and isDeviceSecure

Bug: 20642788
Change-Id: I1114150cd645ee3de8e4617cdb79ff351e01b9df
---
 core/java/android/app/KeyguardManager.java | 20 +++++++++-----------
 1 file changed, 9 insertions(+), 11 deletions(-)

diff --git a/core/java/android/app/KeyguardManager.java b/core/java/android/app/KeyguardManager.java
index ebb3c43fc7598..2c1231773bb4f 100644
--- a/core/java/android/app/KeyguardManager.java
+++ b/core/java/android/app/KeyguardManager.java
@@ -199,9 +199,12 @@ public class KeyguardManager {
     }
 
     /**
-     * Return whether the keyguard requires a password to unlock.
+     * Return whether the keyguard is secured by a PIN, pattern or password or a SIM card
+     * is currently locked.
      *
-     * @return true if keyguard is secure.
+     * <p>See also {@link #isDeviceSecure()} which ignores SIM locked states.
+     *
+     * @return true if a PIN, pattern or password is set or a SIM card is locked.
      */
     public boolean isKeyguardSecure() {
         try {
@@ -240,12 +243,8 @@ public class KeyguardManager {
     }
 
     /**
-     * Returns whether the device is currently locked and requires a PIN, pattern or
-     * password to unlock.
+     * Per-user version of {@link #isDeviceLocked()}.
      *
-     * @param userId the user for which the locked state should be reported.
-     * @return true if unlocking the device currently requires a PIN, pattern or
-     * password.
      * @hide
      */
     public boolean isDeviceLocked(int userId) {
@@ -260,6 +259,8 @@ public class KeyguardManager {
      * Returns whether the device is secured with a PIN, pattern or
      * password.
      *
+     * <p>See also {@link #isKeyguardSecure} which treats SIM locked states as secure.
+     *
      * @return true if a PIN, pattern or password was set.
      */
     public boolean isDeviceSecure() {
@@ -267,11 +268,8 @@ public class KeyguardManager {
     }
 
     /**
-     * Returns whether the device is secured with a PIN, pattern or
-     * password.
+     * Per-user version of {@link #isDeviceSecure()}.
      *
-     * @param userId the user for which the secure state should be reported.
-     * @return true if a PIN, pattern or password was set.
      * @hide
      */
     public boolean isDeviceSecure(int userId) {