Improve getPropertyValue (#2998)

Author: jush

extension-style/api/Release/metalava.txt

@@ -7957,10 +7957,12 @@ package com.mapbox.maps.extension.style.utils {
     method public static com.mapbox.bindgen.Value toValue(com.mapbox.geojson.FeatureCollection);
     method public static com.mapbox.bindgen.Value toValue(com.mapbox.geojson.Geometry);
     method public static inline com.mapbox.maps.TransitionOptions transition(kotlin.jvm.functions.Function1<? super com.mapbox.maps.TransitionOptions.Builder,kotlin.Unit> block);
+    method public static <T> T! unwrap(com.mapbox.maps.StylePropertyValue, Class<T> clazz);
     method public static inline <reified T> T! unwrap(com.mapbox.maps.StylePropertyValue);
     method public static Object unwrapToAny(com.mapbox.bindgen.Value);
     method public static com.mapbox.maps.extension.style.expressions.generated.Expression unwrapToExpression(com.mapbox.bindgen.Value);
     method public static com.mapbox.maps.extension.style.types.StyleTransition unwrapToStyleTransition(com.mapbox.bindgen.Value);
+    method public static <T> T! unwrapToTyped(com.mapbox.bindgen.Value, Class<T> clazz);
     method public static inline <reified T> T! unwrapToTyped(com.mapbox.bindgen.Value);
   }
 

extension-style/api/extension-style.api

@@ -6763,8 +6763,10 @@ public final class com/mapbox/maps/extension/style/utils/TypeUtilsKt {
 	public static final fun toValue (Lcom/mapbox/geojson/FeatureCollection;)Lcom/mapbox/bindgen/Value;
 	public static final fun toValue (Lcom/mapbox/geojson/Geometry;)Lcom/mapbox/bindgen/Value;
 	public static final fun transition (Lkotlin/jvm/functions/Function1;)Lcom/mapbox/maps/TransitionOptions;
+	public static final fun unwrap (Lcom/mapbox/maps/StylePropertyValue;Ljava/lang/Class;)Ljava/lang/Object;
 	public static final fun unwrapToAny (Lcom/mapbox/bindgen/Value;)Ljava/lang/Object;
 	public static final fun unwrapToExpression (Lcom/mapbox/bindgen/Value;)Lcom/mapbox/maps/extension/style/expressions/generated/Expression;
 	public static final fun unwrapToStyleTransition (Lcom/mapbox/bindgen/Value;)Lcom/mapbox/maps/extension/style/types/StyleTransition;
+	public static final fun unwrapToTyped (Lcom/mapbox/bindgen/Value;Ljava/lang/Class;)Ljava/lang/Object;
 }
 

extension-style/src/main/java/com/mapbox/maps/extension/style/atmosphere/generated/Atmosphere.kt

@@ -71,12 +71,7 @@ class CustomLayer constructor(
      *
      * @return VISIBILITY as expression
      */
-    get() {
-      getPropertyValue<Expression>("visibility")?.let {
-        return it
-      }
-      return null
-    }
+    get() = getPropertyValue("visibility")
 
   /**
    * Whether this layer is displayed.
@@ -117,9 +112,7 @@ class CustomLayer constructor(
      *
      * @return minzoom
      */
-    get() {
-      return getPropertyValue("minzoom")
-    }
+    get() = getPropertyValue("minzoom")
 
   /**
    * The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.
@@ -152,9 +145,7 @@ class CustomLayer constructor(
      *
      * @return maxzoom
      */
-    get() {
-      return getPropertyValue("maxzoom")
-    }
+    get() = getPropertyValue("maxzoom")
 
   /**
    * The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
@@ -193,9 +184,7 @@ class CustomLayer constructor(
      *
      * @return slot
      */
-    get() {
-      return getPropertyValue("slot")
-    }
+    get() = getPropertyValue("slot")
 
   override fun addPersistentLayer(
     delegate: MapboxStyleManager,

extension-style/src/main/java/com/mapbox/maps/extension/style/layers/CustomLayer.kt

@@ -13,6 +13,7 @@ import com.mapbox.maps.extension.style.layers.generated.BackgroundLayer
 import com.mapbox.maps.extension.style.layers.properties.PropertyValue
 import com.mapbox.maps.extension.style.layers.properties.generated.Visibility
 import com.mapbox.maps.extension.style.utils.unwrap
+import com.mapbox.maps.extension.style.utils.unwrapToExpressionOrLiteralExpression
 
 /**
  * Base class for the different Layer types
@@ -223,13 +224,17 @@ abstract class Layer : StyleContract.StyleLayerExtension {
   }
 
   internal inline fun <reified T> getPropertyValue(propertyName: String): T? {
+    return getPropertyValueWithType(propertyName, T::class.java)
+  }
+
+  private fun <T> getPropertyValueWithType(propertyName: String, clazz: Class<T>): T? {
     delegate?.let {
       return try {
-        it.getStyleLayerProperty(layerId, propertyName).unwrap()
+        it.getStyleLayerProperty(layerId, propertyName).unwrap(clazz)
       } catch (e: RuntimeException) {
         // logging an error is misleading as it is valid to set a property
         // with a concrete value (e.g. Double) and then read it as an expression
-        if (T::class != Expression::class) {
+        if (clazz != Expression::class.java) {
           Log.e(
             TAG,
             "Get layer property=$propertyName for layerId=$layerId failed: ${e.message}. " +
@@ -242,6 +247,22 @@ abstract class Layer : StyleContract.StyleLayerExtension {
     throw MapboxStyleException("Couldn't get $propertyName: layer is not added to style yet.")
   }
 
+  internal fun getPropertyValueAsExpressionOrLiteralExpression(propertyName: String): Expression? {
+    delegate?.let {
+      return try {
+        it.getStyleLayerProperty(layerId, propertyName).unwrapToExpressionOrLiteralExpression()
+      } catch (e: RuntimeException) {
+        Log.e(
+          TAG,
+          "Get layer property=$propertyName for layerId=$layerId failed: ${e.message}. " +
+            "Value obtained: ${it.getStyleLayerProperty(layerId, propertyName)}"
+        )
+        null
+      }
+    }
+    throw MapboxStyleException("Couldn't get $propertyName: layer is not added to style yet.")
+  }
+
   /**
    * Returns a human readable string that includes the cached properties of the layer.
    *