From cc0a4820ebaaf07a4643d43d7ce25907ca78d13b Mon Sep 17 00:00:00 2001 From: Greg Kaiser Date: Thu, 25 Feb 2016 16:14:17 -0800 Subject: [PATCH] SensorEventListener: Clarify documentation. "onSensorChanged" is really misnamed (perhaps we should deprecate for a better name, but that's beyond the scope of this CL). We will still call this method with identical sensor values if it has a newer timestamp. That is different than the "onAccuracyChanged" behavior. We expand some of this documentation to clarify this point to users. Change-Id: I95fa52574ebac3d20a2354b7b6dcf1bdf513448d --- .../android/hardware/SensorEventListener.java | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/core/java/android/hardware/SensorEventListener.java b/core/java/android/hardware/SensorEventListener.java index 0d859fb976344..0c059ba6bbc1b 100644 --- a/core/java/android/hardware/SensorEventListener.java +++ b/core/java/android/hardware/SensorEventListener.java @@ -18,28 +18,33 @@ package android.hardware; /** * Used for receiving notifications from the SensorManager when - * sensor values have changed. + * there is new sensor data. */ public interface SensorEventListener { /** - * Called when sensor values have changed. + * Called when there is a new sensor event. Note that "on changed" + * is somewhat of a misnomer, as this will also be called if we have a + * new reading from a sensor with the exact same sensor values (but a + * newer timestamp). + * *

See {@link android.hardware.SensorManager SensorManager} * for details on possible sensor types. *

See also {@link android.hardware.SensorEvent SensorEvent}. - * + * *

NOTE: The application doesn't own the * {@link android.hardware.SensorEvent event} * object passed as a parameter and therefore cannot hold on to it. * The object may be part of an internal pool and may be reused by * the framework. * - * @param event the {@link android.hardware.SensorEvent SensorEvent}. + * @param event the {@link android.hardware.SensorEvent SensorEvent}. */ public void onSensorChanged(SensorEvent event); /** - * Called when the accuracy of the registered sensor has changed. + * Called when the accuracy of the registered sensor has changed. Unlike + * onSensorChanged(), this is only called when this accuracy value changes. * *

See the SENSOR_STATUS_* constants in * {@link android.hardware.SensorManager SensorManager} for details.