Merge "Log locations received by default and add javadocs" into sc-dev am: 35260c6f60 am: 109efa3639

Original change: https://googleplex-android-review.googlesource.com/c/platform/frameworks/base/+/15517616

Change-Id: I3269336019c7bace77ddde1f2468fcbcd8a7557c
This commit is contained in:
TreeHugger Robot
2021-08-10 19:08:32 +00:00
committed by Automerger Merge Worker
2 changed files with 20 additions and 7 deletions

View File

@@ -38,9 +38,9 @@ import java.util.concurrent.Executor;
public interface LocationListener { public interface LocationListener {
/** /**
* Called when the location has changed. A wakelock is held on behalf on the listener for some * Called when the location has changed. A wakelock may be held on behalf on the listener for
* brief amount of time as this callback executes. If this callback performs long running * some brief amount of time as this callback executes. If this callback performs long running
* operations, it is the client's responsibility to obtain their own wakelock. * operations, it is the client's responsibility to obtain their own wakelock if necessary.
* *
* @param location the updated location * @param location the updated location
*/ */
@@ -48,7 +48,7 @@ public interface LocationListener {
/** /**
* Called when the location has changed and locations are being delivered in batches. The * Called when the location has changed and locations are being delivered in batches. The
* default implementation calls through to ({@link #onLocationChanged(Location)} with all * default implementation calls through to {@link #onLocationChanged(Location)} with all
* locations in the batch. The list of locations is always guaranteed to be non-empty, and is * locations in the batch. The list of locations is always guaranteed to be non-empty, and is
* always guaranteed to be ordered from earliest location to latest location (so that the * always guaranteed to be ordered from earliest location to latest location (so that the
* earliest location in the batch is at index 0 in the list, and the latest location in the * earliest location in the batch is at index 0 in the list, and the latest location in the
@@ -76,6 +76,11 @@ public interface LocationListener {
* This callback will never be invoked on Android Q and above, and providers can be considered * This callback will never be invoked on Android Q and above, and providers can be considered
* as always in the {@link LocationProvider#AVAILABLE} state. * as always in the {@link LocationProvider#AVAILABLE} state.
* *
* <p class="note">Note that this method only has a default implementation on Android R and
* above, and this method must still be overridden in order to run successfully on Android
* versions below R. LocationListenerCompat from the compat libraries may be used to avoid the
* need to override for older platforms.
*
* @deprecated This callback will never be invoked on Android Q and above. * @deprecated This callback will never be invoked on Android Q and above.
*/ */
@Deprecated @Deprecated
@@ -84,6 +89,11 @@ public interface LocationListener {
/** /**
* Called when a provider this listener is registered with becomes enabled. * Called when a provider this listener is registered with becomes enabled.
* *
* <p class="note">Note that this method only has a default implementation on Android R and
* above, and this method must still be overridden in order to run successfully on Android
* versions below R. LocationListenerCompat from the compat libraries may be used to avoid the
* need to override for older platforms.
*
* @param provider the name of the location provider * @param provider the name of the location provider
*/ */
default void onProviderEnabled(@NonNull String provider) {} default void onProviderEnabled(@NonNull String provider) {}
@@ -92,6 +102,11 @@ public interface LocationListener {
* Called when the provider this listener is registered with becomes disabled. If a provider is * Called when the provider this listener is registered with becomes disabled. If a provider is
* disabled when this listener is registered, this callback will be invoked immediately. * disabled when this listener is registered, this callback will be invoked immediately.
* *
* <p class="note">Note that this method only has a default implementation on Android R and
* above, and this method must still be overridden in order to run successfully on Android
* versions below R. LocationListenerCompat from the compat libraries may be used to avoid the
* need to override for older platforms.
*
* @param provider the name of the location provider * @param provider the name of the location provider
*/ */
default void onProviderDisabled(@NonNull String provider) {} default void onProviderDisabled(@NonNull String provider) {}

View File

@@ -192,9 +192,7 @@ public class LocationEventLog extends LocalEventLog {
/** Logs a new incoming location for a location provider. */ /** Logs a new incoming location for a location provider. */
public void logProviderReceivedLocations(String provider, int numLocations) { public void logProviderReceivedLocations(String provider, int numLocations) {
if (D) { addLogEvent(EVENT_PROVIDER_RECEIVE_LOCATION, provider, numLocations);
addLogEvent(EVENT_PROVIDER_RECEIVE_LOCATION, provider, numLocations);
}
} }
/** Logs a location deliver for a client of a location provider. */ /** Logs a location deliver for a client of a location provider. */