From 409e5d25a91cacdab6bd2a4c338d2ef1c84fa318 Mon Sep 17 00:00:00 2001 From: Jiyong Park Date: Tue, 27 Feb 2018 22:00:23 +0900 Subject: [PATCH] Create the stubs lib for com.android.location.provider com.android.location.provider.stubs is the stubs library for the shared library com.android.location.provider. The stubs library is intended to provide the stable set of APIs to the apps implementing location provider. Without the stubs library, apps had to directly link to the shared library which is built without Android SDK and exposes private APIs that are not intended to be used by apps. This also has been causing the lin-type check warnings when the shared lib is used by apps built with SDK; apps built with SDK is not allowed to link to lib built without SDK. This has been reported as warnings but will soon be errors. Now such apps are required to link to the stubs lib, which is built with SDK. While building the stubs library, following APIs are made hidden because they are exposing private APIs from the Android platform. 1) Activity* classes are removed from the API, as they are not intended to be used by apps since O. 2) GeocodeProvider and GeofenceProvider are removed from the API. 3) LocationProvider.mLocationManager is removed as it is exposing the private symbol ILocationProvider 4) ProviderPropertiesUnbundle.getProviderProperties are removed from the API as it is exposing the private symbol ProviderProperties. 5) The constructor of ProviderRequestUnbundled is removed since the class is intended to be instantiated by the service. Bug: 71420593 Test: m -j com.android.location.provider.stubs Merged-In: I20aba7e9ca9c3adc75db241f37a55f0d657f3ced Change-Id: I20aba7e9ca9c3adc75db241f37a55f0d657f3ced (cherry picked from commit eee99986c8021d6825f99a25434725fccf7b2b12) --- location/lib/Android.mk | 22 +++++++++++++++++++ .../provider/ActivityChangedEvent.java | 1 + .../provider/ActivityRecognitionEvent.java | 1 + .../provider/ActivityRecognitionProvider.java | 1 + .../ActivityRecognitionProviderClient.java | 1 + .../ActivityRecognitionProviderWatcher.java | 1 + .../location/provider/GeocodeProvider.java | 1 + .../location/provider/GeofenceProvider.java | 1 + .../provider/GmsFusedBatchOptions.java | 2 +- .../provider/LocationProviderBase.java | 1 + .../provider/ProviderPropertiesUnbundled.java | 1 + .../provider/ProviderRequestUnbundled.java | 1 + 12 files changed, 33 insertions(+), 1 deletion(-) diff --git a/location/lib/Android.mk b/location/lib/Android.mk index 8424601a57ef5..6642134ec32b8 100644 --- a/location/lib/Android.mk +++ b/location/lib/Android.mk @@ -42,3 +42,25 @@ LOCAL_MODULE_PATH := $(TARGET_OUT_ETC)/permissions LOCAL_SRC_FILES := $(LOCAL_MODULE) include $(BUILD_PREBUILT) + +# ==== Stub library =========================================== +include $(CLEAR_VARS) +LOCAL_MODULE := com.android.location.provider-stubs-gen +LOCAL_MODULE_CLASS := JAVA_LIBRARIES +LOCAL_SRC_FILES := $(call all-java-files-under,java) +LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/com.android.location.provider.stubs_intermediates/src +LOCAL_DROIDDOC_OPTIONS:= \ + -hide 111 -hide 113 -hide 125 -hide 126 -hide 127 -hide 128 \ + -stubpackages com.android.location.provider \ + -nodocs +LOCAL_UNINSTALLABLE_MODULE := true +include $(BUILD_DROIDDOC) +com_android_nfc_extras_gen_stamp := $(full_target) + +include $(CLEAR_VARS) +LOCAL_MODULE := com.android.location.provider.stubs +LOCAL_SOURCE_FILES_ALL_GENERATED := true +LOCAL_SDK_VERSION := current +LOCAL_ADDITIONAL_DEPENDENCIES := $(com_android_nfc_extras_gen_stamp) +com_android_nfc_extras_gen_stamp := +include $(BUILD_STATIC_JAVA_LIBRARY) diff --git a/location/lib/java/com/android/location/provider/ActivityChangedEvent.java b/location/lib/java/com/android/location/provider/ActivityChangedEvent.java index c7dfc887bbbb1..843dd670315a0 100644 --- a/location/lib/java/com/android/location/provider/ActivityChangedEvent.java +++ b/location/lib/java/com/android/location/provider/ActivityChangedEvent.java @@ -23,6 +23,7 @@ import java.util.List; /** * A class representing an event for Activity changes. + * @hide */ public class ActivityChangedEvent { private final List mActivityRecognitionEvents; diff --git a/location/lib/java/com/android/location/provider/ActivityRecognitionEvent.java b/location/lib/java/com/android/location/provider/ActivityRecognitionEvent.java index a39cff2285671..e54dea40d6903 100644 --- a/location/lib/java/com/android/location/provider/ActivityRecognitionEvent.java +++ b/location/lib/java/com/android/location/provider/ActivityRecognitionEvent.java @@ -18,6 +18,7 @@ package com.android.location.provider; /** * A class that represents an Activity Recognition Event. + * @hide */ public class ActivityRecognitionEvent { private final String mActivity; diff --git a/location/lib/java/com/android/location/provider/ActivityRecognitionProvider.java b/location/lib/java/com/android/location/provider/ActivityRecognitionProvider.java index bc2dae14be384..0eff7d3f2014c 100644 --- a/location/lib/java/com/android/location/provider/ActivityRecognitionProvider.java +++ b/location/lib/java/com/android/location/provider/ActivityRecognitionProvider.java @@ -28,6 +28,7 @@ import java.util.HashSet; /** * A class that exposes {@link IActivityRecognitionHardware} functionality to unbundled services. + * @hide */ public final class ActivityRecognitionProvider { private final IActivityRecognitionHardware mService; diff --git a/location/lib/java/com/android/location/provider/ActivityRecognitionProviderClient.java b/location/lib/java/com/android/location/provider/ActivityRecognitionProviderClient.java index 0b878d7c1f2b8..326d901b9daa7 100644 --- a/location/lib/java/com/android/location/provider/ActivityRecognitionProviderClient.java +++ b/location/lib/java/com/android/location/provider/ActivityRecognitionProviderClient.java @@ -27,6 +27,7 @@ import android.util.Log; /** * A client class for interaction with an Activity-Recognition provider. + * @hide */ public abstract class ActivityRecognitionProviderClient { private static final String TAG = "ArProviderClient"; diff --git a/location/lib/java/com/android/location/provider/ActivityRecognitionProviderWatcher.java b/location/lib/java/com/android/location/provider/ActivityRecognitionProviderWatcher.java index 7139025d2722d..42f77b42766ff 100644 --- a/location/lib/java/com/android/location/provider/ActivityRecognitionProviderWatcher.java +++ b/location/lib/java/com/android/location/provider/ActivityRecognitionProviderWatcher.java @@ -30,6 +30,7 @@ import android.util.Log; * A watcher class for Activity-Recognition instances. * * @deprecated use {@link ActivityRecognitionProviderClient} instead. + * @hide */ @Deprecated public class ActivityRecognitionProviderWatcher { diff --git a/location/lib/java/com/android/location/provider/GeocodeProvider.java b/location/lib/java/com/android/location/provider/GeocodeProvider.java index d7a34af332ca7..f7f3d82169a76 100644 --- a/location/lib/java/com/android/location/provider/GeocodeProvider.java +++ b/location/lib/java/com/android/location/provider/GeocodeProvider.java @@ -33,6 +33,7 @@ import java.util.List; *

IMPORTANT: This class is effectively a public API for unbundled * applications, and must remain API stable. See README.txt in the root * of this package for more information. + * @hide */ public abstract class GeocodeProvider { diff --git a/location/lib/java/com/android/location/provider/GeofenceProvider.java b/location/lib/java/com/android/location/provider/GeofenceProvider.java index fafaa8462dd91..43690ab87cf26 100644 --- a/location/lib/java/com/android/location/provider/GeofenceProvider.java +++ b/location/lib/java/com/android/location/provider/GeofenceProvider.java @@ -31,6 +31,7 @@ import android.location.IGeofenceProvider; *

IMPORTANT: This class is effectively a public API for unbundled * applications, and must remain API stable. See README.txt in the root * of this package for more information. + * @hide */ public abstract class GeofenceProvider { diff --git a/location/lib/java/com/android/location/provider/GmsFusedBatchOptions.java b/location/lib/java/com/android/location/provider/GmsFusedBatchOptions.java index 29818ecb85cba..13278e7afc1ff 100644 --- a/location/lib/java/com/android/location/provider/GmsFusedBatchOptions.java +++ b/location/lib/java/com/android/location/provider/GmsFusedBatchOptions.java @@ -105,7 +105,7 @@ public class GmsFusedBatchOptions { * Method definitions for internal use. */ - /* + /** * @hide */ public FusedBatchOptions getParcelableOptions() { diff --git a/location/lib/java/com/android/location/provider/LocationProviderBase.java b/location/lib/java/com/android/location/provider/LocationProviderBase.java index d717f40cab597..30655f5bbf10f 100644 --- a/location/lib/java/com/android/location/provider/LocationProviderBase.java +++ b/location/lib/java/com/android/location/provider/LocationProviderBase.java @@ -56,6 +56,7 @@ import com.android.internal.util.FastPrintWriter; public abstract class LocationProviderBase { private final String TAG; + /** @hide */ protected final ILocationManager mLocationManager; private final ProviderProperties mProperties; private final IBinder mBinder; diff --git a/location/lib/java/com/android/location/provider/ProviderPropertiesUnbundled.java b/location/lib/java/com/android/location/provider/ProviderPropertiesUnbundled.java index 9ee4df21c8941..b1a1bda45f395 100644 --- a/location/lib/java/com/android/location/provider/ProviderPropertiesUnbundled.java +++ b/location/lib/java/com/android/location/provider/ProviderPropertiesUnbundled.java @@ -41,6 +41,7 @@ public final class ProviderPropertiesUnbundled { mProperties = properties; } + /** @hide */ public ProviderProperties getProviderProperties() { return mProperties; } diff --git a/location/lib/java/com/android/location/provider/ProviderRequestUnbundled.java b/location/lib/java/com/android/location/provider/ProviderRequestUnbundled.java index ad3d1df355485..6a8e61877e46f 100644 --- a/location/lib/java/com/android/location/provider/ProviderRequestUnbundled.java +++ b/location/lib/java/com/android/location/provider/ProviderRequestUnbundled.java @@ -33,6 +33,7 @@ import com.android.internal.location.ProviderRequest; public final class ProviderRequestUnbundled { private final ProviderRequest mRequest; + /** @hide */ public ProviderRequestUnbundled(ProviderRequest request) { mRequest = request; }