[android] - deprecate MyLocationView in favor of LocationLayer pluginupstream/tvn-deprecate-mylocationview

4 files changed, 37 insertions, 0 deletions

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
index cbb1d47b14..becf337545 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
@@ -548,7 +548,10 @@ public final class MapboxMap {
    * Gets the tracking interface settings for the map.
    *
    * @return the TrackingSettings asssociated with this map
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
+  @Deprecated
   public TrackingSettings getTrackingSettings() {
     return trackingSettings;
   }
@@ -561,7 +564,10 @@ public final class MapboxMap {
    * Gets the settings of the user location for the map.
    *
    * @return the MyLocationViewSettings associated with this map
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
+  @Deprecated
   public MyLocationViewSettings getMyLocationViewSettings() {
     return myLocationViewSettings;
   }
@@ -1810,7 +1816,10 @@ public final class MapboxMap {
    * Returns the status of the my-location layer.
    *
    * @return True if the my-location layer is enabled, false otherwise.
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
+  @Deprecated
   public boolean isMyLocationEnabled() {
     return trackingSettings.isMyLocationEnabled();
   }
@@ -1825,7 +1834,10 @@ public final class MapboxMap {
    * android.Manifest.permission#ACCESS_COARSE_LOCATION or android.Manifest.permission#ACCESS_FINE_LOCATION.
    *
    * @param enabled True to enable; false to disable.
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
+  @Deprecated
   public void setMyLocationEnabled(boolean enabled) {
     trackingSettings.setMyLocationEnabled(enabled);
   }
@@ -1834,8 +1846,11 @@ public final class MapboxMap {
    * Returns the currently displayed user location, or null if there is no location data available.
    *
    * @return The currently displayed user location.
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
   @Nullable
+  @Deprecated
   public Location getMyLocation() {
     return trackingSettings.getMyLocation();
   }
@@ -1846,7 +1861,10 @@ public final class MapboxMap {
    *
    * @param listener The callback that's invoked when the user clicks on a marker.
    *                 To unset the callback, use null.
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
+  @Deprecated
   public void setOnMyLocationChangeListener(@Nullable MapboxMap.OnMyLocationChangeListener
                                               listener) {
     trackingSettings.setOnMyLocationChangeListener(listener);
@@ -1856,7 +1874,10 @@ public final class MapboxMap {
    * Replaces the location source of the my-location layer.
    *
    * @param locationSource A {@link LocationEngine} location source to use in the my-location layer.
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
+  @Deprecated
   public void setLocationSource(@Nullable LocationEngine locationSource) {
     trackingSettings.setLocationSource(locationSource);
   }
@@ -1866,7 +1887,10 @@ public final class MapboxMap {
    *
    * @param listener The callback that's invoked when the location tracking mode changes.
    *                 To unset the callback, use null.
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
+  @Deprecated
   public void setOnMyLocationTrackingModeChangeListener(
     @Nullable MapboxMap.OnMyLocationTrackingModeChangeListener listener) {
     trackingSettings.setOnMyLocationTrackingModeChangeListener(listener);
@@ -1877,7 +1901,10 @@ public final class MapboxMap {
    *
    * @param listener The callback that's invoked when the bearing tracking mode changes.
    *                 To unset the callback, use null.
+   * @deprecated use location layer plugin from
+   * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
    */
+  @Deprecated
   public void setOnMyBearingTrackingModeChangeListener(@Nullable OnMyBearingTrackingModeChangeListener listener) {
     trackingSettings.setOnMyBearingTrackingModeChangeListener(listener);
   }
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
index bd0bf7c83b..6881ca067b 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
@@ -20,7 +20,11 @@ import timber.log.Timber;
 
 /**
  * Settings for the user location and bearing tracking of a MapboxMap.
+ *
+ * @deprecated use location layer plugin from
+ * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
  */
+@Deprecated
 public final class TrackingSettings {
 
   private final MyLocationView myLocationView;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationView.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationView.java
index 22e92872a5..a0ca3297f4 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationView.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationView.java
@@ -49,7 +49,10 @@ import timber.log.Timber;
  * <p>
  * Use {@link MyLocationViewSettings} to manipulate the state of this view.
  * </p>
+ * @deprecated use location layer plugin from
+ * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
  */
+@Deprecated
 public class MyLocationView extends View {
 
   private static final int UNDEFINED_TINT_COLOR = -1;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationViewSettings.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationViewSettings.java
index ea74bc57aa..a1d5b13b8b 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationViewSettings.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationViewSettings.java
@@ -13,7 +13,10 @@ import com.mapbox.mapboxsdk.maps.Projection;
 
 /**
  * Settings to configure the visual appearance of the MyLocationView.
+ * @deprecated use location layer plugin from
+ * https://github.com/mapbox/mapbox-plugins-android/tree/master/plugins/locationlayer instead.
  */
+@Deprecated
 public class MyLocationViewSettings {
 
   private Projection projection;