Fix the javadoc for LocationManager.requestSingleUpdate()

It was saying the same thing as requestLocationUpdates(), but it only provides a single update.

Change-Id: I0a0f612104a946b7db96928505bb95673377a335

1 files changed, 26 insertions, 22 deletions

diff --git a/location/java/android/location/LocationManager.java b/location/java/android/location/LocationManager.java
index 9aa84a03..cc689bb 100644
--- a/location/java/android/location/LocationManager.java
+++ b/location/java/android/location/LocationManager.java
@@ -715,15 +715,13 @@ public class LocationManager {
     }
 
     /**
-     * Registers the current activity to be notified periodically by
-     * the named provider.  Periodically, the supplied LocationListener will
-     * be called with the current Location or with status updates.
+     * Requests a single location update from the named provider.
      *
      * <p> It may take a while to receive the most recent location. If
      * an immediate location is required, applications may use the
      * {@link #getLastKnownLocation(String)} method.
      *
-     * <p> In case the provider is disabled by the user, updates will stop,
+     * <p> In case the provider is disabled by the user, the update will not be received,
      * and the {@link LocationListener#onProviderDisabled(String)}
      * method will be called. As soon as the provider is enabled again,
      * the {@link LocationListener#onProviderEnabled(String)} method will
@@ -733,8 +731,8 @@ public class LocationManager {
      *
      * @param provider the name of the provider with which to register
      * @param listener a {#link LocationListener} whose
-     * {@link LocationListener#onLocationChanged} method will be called for
-     * each location update
+     * {@link LocationListener#onLocationChanged} method will be called when
+     * the location update is available
      * @param looper a Looper object whose message queue will be used to
      * implement the callback mechanism.
      * If looper is null then the callbacks will be called on the main thread.
@@ -754,15 +752,13 @@ public class LocationManager {
     }
 
     /**
-     * Registers the current activity to be notified periodically based on
-     * the specified criteria.  Periodically, the supplied LocationListener will
-     * be called with the current Location or with status updates.
+     * Requests a single location update based on the specified criteria.
      *
      * <p> It may take a while to receive the most recent location. If
      * an immediate location is required, applications may use the
      * {@link #getLastKnownLocation(String)} method.
      *
-     * <p> In case the provider is disabled by the user, updates will stop,
+     * <p> In case the provider is disabled by the user, the update will not be received,
      * and the {@link LocationListener#onProviderDisabled(String)}
      * method will be called. As soon as the provider is enabled again,
      * the {@link LocationListener#onProviderEnabled(String)} method will
@@ -773,8 +769,8 @@ public class LocationManager {
      * @param criteria contains parameters for the location manager to choose the
      * appropriate provider and parameters to compute the location
      * @param listener a {#link LocationListener} whose
-     * {@link LocationListener#onLocationChanged} method will be called for
-     * each location update
+     * {@link LocationListener#onLocationChanged} method will be called when
+     * the location update is available
      * @param looper a Looper object whose message queue will be used to
      * implement the callback mechanism.
      * If looper is null then the callbacks will be called on the current thread.
@@ -795,16 +791,20 @@ public class LocationManager {
     }
 
     /**
-     * Registers the current activity to be notified periodically by
-     * the named provider.  Periodically, the supplied PendingIntent will
-     * be broadcast with the current Location or with status updates.
-     *
-     * <p> Location updates are sent with a key of KEY_LOCATION_CHANGED and a Location value.
+     * Requests a single location update from the named provider.
      *
      * <p> It may take a while to receive the most recent location. If
      * an immediate location is required, applications may use the
      * {@link #getLastKnownLocation(String)} method.
      *
+     * <p> Location updates are sent with a key of KEY_LOCATION_CHANGED and a Location value.
+     *
+     * <p> In case the provider is disabled by the user, the update will not be received,
+     * and the {@link LocationListener#onProviderDisabled(String)}
+     * method will be called. As soon as the provider is enabled again,
+     * the {@link LocationListener#onProviderEnabled(String)} method will
+     * be called and location updates will start again.
+     *
      * @param provider the name of the provider with which to register
      * @param intent a {#link PendingIntent} to be sent for the location update
      *
@@ -823,16 +823,20 @@ public class LocationManager {
     }
 
     /**
-     * Registers the current activity to be notified periodically based on
-     * the specified criteria.  Periodically, the supplied PendingIntent will
-     * be broadcast with the current Location or with status updates.
-     *
-     * <p> Location updates are sent with a key of KEY_LOCATION_CHANGED and a Location value.
+     * Requests a single location update based on the specified criteria.
      *
      * <p> It may take a while to receive the most recent location. If
      * an immediate location is required, applications may use the
      * {@link #getLastKnownLocation(String)} method.
      *
+     * <p> Location updates are sent with a key of KEY_LOCATION_CHANGED and a Location value.
+     *
+     * <p> In case the provider is disabled by the user, the update will not be received,
+     * and the {@link LocationListener#onProviderDisabled(String)}
+     * method will be called. As soon as the provider is enabled again,
+     * the {@link LocationListener#onProviderEnabled(String)} method will
+     * be called and location updates will start again.
+     *
      * @param criteria contains parameters for the location manager to choose the
      * appropriate provider and parameters to compute the location
      * @param intent a {#link PendingIntent} to be sent for the location update