From 8f886322ae5ba416f8ad5777af7bbd8972e44f0d Mon Sep 17 00:00:00 2001 From: karthik bharadwaj Date: Tue, 15 Jun 2021 16:57:41 -0700 Subject: [PATCH] Update code comments to mention sensor name uniqueness. Bug: 179076515 Test: N/A Change-Id: I906000864a14acd1dcd364ad71c4dde5233dd700 --- core/java/android/hardware/Sensor.java | 3 ++- core/java/android/hardware/SensorManager.java | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/core/java/android/hardware/Sensor.java b/core/java/android/hardware/Sensor.java index ec6c233848597..37469e916eef5 100644 --- a/core/java/android/hardware/Sensor.java +++ b/core/java/android/hardware/Sensor.java @@ -952,7 +952,8 @@ public final class Sensor { } /** - * @return name string of the sensor. + * @return name string of the sensor. The name is guaranteed to be unique + * for a particular sensor type. */ public String getName() { return mName; diff --git a/core/java/android/hardware/SensorManager.java b/core/java/android/hardware/SensorManager.java index 0a76a9c6bee35..713b66abed211 100644 --- a/core/java/android/hardware/SensorManager.java +++ b/core/java/android/hardware/SensorManager.java @@ -399,7 +399,9 @@ public abstract class SensorManager { * Use this method to get the list of available sensors of a certain type. * Make multiple calls to get sensors of different types or use * {@link android.hardware.Sensor#TYPE_ALL Sensor.TYPE_ALL} to get all the - * sensors. + * sensors. Note that the {@link android.hardware.Sensor#getName()} is + * expected to yield a value that is unique across any sensors that return + * the same value for {@link android.hardware.Sensor#getType()}. * *

* NOTE: Both wake-up and non wake-up sensors matching the given type are