[android] #4702 - upgrade default styles, deprecate Style string definition in favour versioned styling methods.

1 files changed, 166 insertions, 6 deletions

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java
index 31c146b43e..61c7bfd9ce 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java
@@ -1,11 +1,14 @@
 package com.mapbox.mapboxsdk.constants;
 
+import android.support.annotation.IntRange;
 import android.support.annotation.StringDef;
 
 import com.mapbox.mapboxsdk.maps.MapView;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
+import java.util.Locale;
+
 /**
  * <p>
  * Style provides URLs to several professional styles designed by Mapbox.
@@ -17,10 +20,146 @@ import java.lang.annotation.RetentionPolicy;
 public class Style {
 
     /**
+     * Mapbox Streets: A complete basemap, perfect for incorporating your own data.
+     */
+    private static final String MAPBOX_STREETS_BASE = "mapbox://styles/mapbox/streets-v%d";
+    /**
+     * Outdoors: A rugged style that emphasizes physical terrain and outdoor activities.
+     */
+    private static final String OUTDOORS_BASE = "mapbox://styles/mapbox/outdoors-v%d";
+    /**
+     * Light: Subtle light backdrop for data visualizations.
+     */
+    private static final String LIGHT_BASE = "mapbox://styles/mapbox/light-v%d";
+    /**
+     * Dark: Subtle dark backdrop for data visualizations.
+     */
+    private static final String DARK_BASE = "mapbox://styles/mapbox/dark-v%d";
+    /**
+     * Satellite: A beautiful global satellite and aerial imagery layer.
+     */
+    private static final String SATELLITE_BASE = "mapbox://styles/mapbox/satellite-v%d";
+    /**
+     * Satellite Streets: Global satellite and aerial imagery with unobtrusive labels.
+     */
+    private static final String SATELLITE_STREETS_BASE = "mapbox://styles/mapbox/satellite-hybrid-v%d";
+
+    /**
+     * Get versioned url of Mapbox streets style.
+     * <p>
+     * <ul>
+     * <li>Current default version is 9.</li>
+     * </ul
+     * </p>
+     * <p>
+     * More information on the Mapbox styles API can be found on https://www.mapbox.com/api-documentation/#styles
+     * </p>
+     *
+     * @param version the version of the style.
+     * @return uri to load style from
+     */
+    public static String getMapboxStreetsUrl(int version) {
+        return String.format(Locale.US, MAPBOX_STREETS_BASE, version);
+    }
+
+    /**
+     * Get versioned url of Outdoors streets style.
+     * <p>
+     * <ul>
+     * <li>Current version is 9.</li>
+     * </ul>
+     * </p>
+     * <p>
+     * More information on the Mapbox styles API can be found on https://www.mapbox.com/api-documentation/#styles
+     * </p>
+     *
+     * @param version the version of the style.
+     * @return uri to load style from
+     */
+    public static String getOutdoorsStyleUrl(int version) {
+        return String.format(Locale.US, OUTDOORS_BASE, version);
+    }
+
+    /**
+     * Get versioned url of Light style.
+     * <p>
+     * <ul>
+     * <li>Current default version is 9.</li>
+     * </ul>
+     * </p>
+     * <p>
+     * More information on the Mapbox styles API can be found on https://www.mapbox.com/api-documentation/#styles
+     * </p>
+     *
+     * @param version the version of the style.
+     * @return uri to load style from
+     */
+    public static String getLightStyleUrl(int version) {
+        return String.format(Locale.US, LIGHT_BASE, version);
+    }
+
+    /**
+     * Get versioned url of Dark style.
+     * <p>
+     * <ul>
+     * <li>Current default version is 9.</li>
+     * </ul>
+     * </p>
+     * <p>
+     * More information on the Mapbox styles API can be found on https://www.mapbox.com/api-documentation/#styles
+     * </p>
+     *
+     * @param version the version of the style.
+     * @return uri to load style from
+     */
+    public static String getDarkStyleUrl(int version) {
+        return String.format(Locale.US, DARK_BASE, version);
+    }
+
+    /**
+     * Get versioned url of Satellite style.
+     * <p>
+     * <ul>
+     * <li>Current version is 9.</li>
+     * </ul>
+     * </p>
+     * <p>
+     * More information on the Mapbox styles API can be found on https://www.mapbox.com/api-documentation/#styles
+     * </p>
+     *
+     * @param version the version of the style.
+     * @return uri to load style from
+     */
+    public static String getSatelliteStyleUrl(int version) {
+        return String.format(Locale.US, SATELLITE_BASE, version);
+    }
+
+    /**
+     * Get versioned url of Satellite streets style.
+     * <p>
+     * <ul>
+     * <li>Current version is 9.</li>
+     * </ul>
+     * </p>
+     * <p>
+     * More information on the Mapbox styles API can be found on https://www.mapbox.com/api-documentation/#styles
+     * </p>
+     *
+     * @param version the version of the style.
+     * @return uri to load style from
+     */
+    public static String getSatelliteStreetsStyleUrl(int version) {
+        return String.format(Locale.US, SATELLITE_STREETS_BASE, version);
+    }
+
+    /**
      * Indicates the parameter accepts one of the values from {@link Style}.
+     *
+     * @deprecated use dedicated versioned methods in {@link Style} instead.
      */
     @StringDef({MAPBOX_STREETS, EMERALD, LIGHT, DARK, SATELLITE, SATELLITE_STREETS})
     @Retention(RetentionPolicy.SOURCE)
+    @Deprecated
     public @interface StyleUrl {
     }
 
@@ -28,28 +167,49 @@ public class Style {
 
     /**
      * Mapbox Streets: A complete basemap, perfect for incorporating your own data.
+     *
+     * @deprecated use {@link #getMapboxStreetsUrl(int)} instead.
      */
-    public static final String MAPBOX_STREETS = "mapbox://styles/mapbox/streets-v8";
+    @Deprecated
+    public static final String MAPBOX_STREETS = "mapbox://styles/mapbox/streets-v9";
+
     /**
      * Emerald: A versatile style, with emphasis on road networks and public transit.
+     *
+     * @deprecated this style has been deprecated and will be removed in future versions.
      */
+    @Deprecated
     public static final String EMERALD = "mapbox://styles/mapbox/emerald-v8";
+
     /**
      * Light: Subtle light backdrop for data visualizations.
+     *
+     * @deprecated use {@link #getLightStyleUrl(int)} instead.
      */
-    public static final String LIGHT = "mapbox://styles/mapbox/light-v8";
+    @Deprecated
+    public static final String LIGHT = "mapbox://styles/mapbox/light-v9";
+
     /**
      * Dark: Subtle dark backdrop for data visualizations.
+     *
+     * @deprecated use {@link #getDarkStyleUrl(int)} (int)} instead.
      */
-    public static final String DARK = "mapbox://styles/mapbox/dark-v8";
+    @Deprecated
+    public static final String DARK = "mapbox://styles/mapbox/dark-v9";
+
     /**
      * Satellite: A beautiful global satellite and aerial imagery layer.
+     *
+     * @deprecated use {@link #getSatelliteStyleUrl(int)} instead.
      */
-    public static final String SATELLITE = "mapbox://styles/mapbox/satellite-v8";
+    @Deprecated
+    public static final String SATELLITE = "mapbox://styles/mapbox/satellite-v9";
 
     /**
      * Satellite Streets: Global satellite and aerial imagery with unobtrusive labels.
+     *
+     * @deprecated use {@link #getSatelliteStreetsStyleUrl(int)} (int)} instead.
      */
-    public static final String SATELLITE_STREETS = "mapbox://styles/mapbox/satellite-hybrid-v8";
-
+    @Deprecated
+    public static final String SATELLITE_STREETS = "mapbox://styles/mapbox/satellite-hybrid-v9";
 }