mark maps classes with UiThread annotation

Author: dzinad

CHANGELOG.md

@@ -7,6 +7,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Moved `MapboxAudioGuidance` and `MapboxAudioGuidanceState` into public api. [#6336](https://github.com/mapbox/mapbox-navigation-android/pull/6336)
 - Introduced `ViewOptionsCustomization.showCameraDebugInfo` to allow end users to enable camera debug info. [#6356](https://github.com/mapbox/mapbox-navigation-android/pull/6356)
 #### Bug fixes and improvements
+- Marked `PredictiveCacheController`, `MapboxBuildingView`, `ViewportDataSourceUpdateObserver`, `NavigationScaleGestureHandler`, `NavigationCameraStateChangedObserver`, `NavigationCameraStateTransition`, `NavigationCameraTransition`, `TransitionEndListener`, `MapboxRecenterButton`, `MapboxRouteOverviewButton`, `MapboxJunctionView`, `MapboxSignboardView`, `MapboxRoadNameLabelView`, `MapboxRoadNameView`, `MapboxRouteArrowView`, `MapboxRouteLineView`, `MapboxCameraModeButton` methods and `View.capture` extension with `@UiThread` annotation. [#6235](https://github.com/mapbox/mapbox-navigation-android/pull/6235)
 
 ## Mapbox Navigation SDK 2.9.0-alpha.2 - 16 September, 2022
 ### Changelog

libnavui-maps/api/current.txt

@@ -11,7 +11,7 @@ package com.mapbox.navigation.ui.maps {
     field public static final String NAVIGATION_NIGHT_STYLE_USER_ID = "mapbox";
   }
 
-  public final class PredictiveCacheController {
+  @UiThread public final class PredictiveCacheController {
     ctor public PredictiveCacheController(com.mapbox.navigation.base.options.PredictiveCacheOptions predictiveCacheOptions);
     ctor @Deprecated public PredictiveCacheController(com.mapbox.navigation.base.options.PredictiveCacheLocationOptions predictiveCacheLocationOptions = PredictiveCacheLocationOptions.<init>().build(), com.mapbox.navigation.ui.maps.PredictiveCacheControllerErrorHandler? predictiveCacheControllerErrorHandler = null);
     ctor @Deprecated public PredictiveCacheController(com.mapbox.navigation.base.options.PredictiveCacheLocationOptions predictiveCacheLocationOptions = PredictiveCacheLocationOptions.<init>().build(), com.mapbox.navigation.base.options.PredictiveCacheLocationOptions predictiveCacheGuidanceLocationOptions = PredictiveCacheLocationOptions.<init>().build(), com.mapbox.navigation.ui.maps.PredictiveCacheControllerErrorHandler? predictiveCacheControllerErrorHandler = null);
@@ -82,7 +82,7 @@ package com.mapbox.navigation.ui.maps.building.model {
 
 package com.mapbox.navigation.ui.maps.building.view {
 
-  public final class MapboxBuildingView {
+  @UiThread public final class MapboxBuildingView {
     ctor public MapboxBuildingView();
     method public void clear(com.mapbox.maps.Style style);
     method public void highlightBuilding(com.mapbox.maps.Style style, java.util.List<com.mapbox.maps.QueriedFeature> buildings, com.mapbox.navigation.ui.maps.building.model.MapboxBuildingHighlightOptions options = MapboxBuildingHighlightOptions.<init>().build());
@@ -322,7 +322,7 @@ package com.mapbox.navigation.ui.maps.camera.data {
   }
 
   public fun interface ViewportDataSourceUpdateObserver {
-    method public void viewportDataSourceUpdated(com.mapbox.navigation.ui.maps.camera.data.ViewportData viewportData);
+    method @UiThread public void viewportDataSourceUpdated(com.mapbox.navigation.ui.maps.camera.data.ViewportData viewportData);
   }
 
 }
@@ -355,10 +355,10 @@ package com.mapbox.navigation.ui.maps.camera.lifecycle {
 
   public final class NavigationScaleGestureHandler implements com.mapbox.maps.plugin.animation.CameraAnimationsLifecycleListener {
     ctor public NavigationScaleGestureHandler(android.content.Context context, com.mapbox.navigation.ui.maps.camera.NavigationCamera navigationCamera, com.mapbox.maps.MapboxMap mapboxMap, com.mapbox.maps.plugin.gestures.GesturesPlugin gesturesPlugin, com.mapbox.maps.plugin.locationcomponent.LocationComponentPlugin locationPlugin, com.mapbox.navigation.ui.maps.camera.lifecycle.NavigationScaleGestureActionListener? scaleActionListener = null, com.mapbox.navigation.ui.maps.camera.lifecycle.NavigationScaleGestureHandlerOptions options = NavigationScaleGestureHandlerOptions.<init>(context).build());
-    method public void cleanup();
+    method @UiThread public void cleanup();
     method public com.mapbox.android.gestures.AndroidGesturesManager getCustomGesturesManager();
     method public com.mapbox.android.gestures.AndroidGesturesManager getInitialGesturesManager();
-    method public void initialize();
+    method @UiThread public void initialize();
     method public boolean isInitialized();
     method public void onAnimatorCancelling(com.mapbox.maps.plugin.animation.CameraAnimatorType type, android.animation.ValueAnimator animator, String? owner);
     method public void onAnimatorEnding(com.mapbox.maps.plugin.animation.CameraAnimatorType type, android.animation.ValueAnimator animator, String? owner);
@@ -400,7 +400,7 @@ package com.mapbox.navigation.ui.maps.camera.state {
   }
 
   public fun interface NavigationCameraStateChangedObserver {
-    method public void onNavigationCameraStateChanged(com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState navigationCameraState);
+    method @UiThread public void onNavigationCameraStateChanged(com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState navigationCameraState);
   }
 
 }
@@ -425,14 +425,14 @@ package com.mapbox.navigation.ui.maps.camera.transition {
   public final class MapboxNavigationCameraTransitionKt {
   }
 
-  public interface NavigationCameraStateTransition {
+  @UiThread public interface NavigationCameraStateTransition {
     method public android.animation.AnimatorSet transitionToFollowing(com.mapbox.maps.CameraOptions cameraOptions, com.mapbox.navigation.ui.maps.camera.transition.NavigationCameraTransitionOptions transitionOptions);
     method public android.animation.AnimatorSet transitionToOverview(com.mapbox.maps.CameraOptions cameraOptions, com.mapbox.navigation.ui.maps.camera.transition.NavigationCameraTransitionOptions transitionOptions);
     method public android.animation.AnimatorSet updateFrameForFollowing(com.mapbox.maps.CameraOptions cameraOptions, com.mapbox.navigation.ui.maps.camera.transition.NavigationCameraTransitionOptions transitionOptions);
     method public android.animation.AnimatorSet updateFrameForOverview(com.mapbox.maps.CameraOptions cameraOptions, com.mapbox.navigation.ui.maps.camera.transition.NavigationCameraTransitionOptions transitionOptions);
   }
 
-  public interface NavigationCameraTransition {
+  @UiThread public interface NavigationCameraTransition {
     method public android.animation.AnimatorSet transitionFromHighZoomToLowZoom(com.mapbox.maps.CameraOptions cameraOptions, com.mapbox.navigation.ui.maps.camera.transition.NavigationCameraTransitionOptions transitionOptions);
     method public android.animation.AnimatorSet transitionFromLowZoomToHighZoom(com.mapbox.maps.CameraOptions cameraOptions, com.mapbox.navigation.ui.maps.camera.transition.NavigationCameraTransitionOptions transitionOptions);
     method public android.animation.AnimatorSet transitionLinear(com.mapbox.maps.CameraOptions cameraOptions, com.mapbox.navigation.ui.maps.camera.transition.NavigationCameraTransitionOptions transitionOptions);
@@ -451,7 +451,7 @@ package com.mapbox.navigation.ui.maps.camera.transition {
   }
 
   public fun interface TransitionEndListener {
-    method public void onTransitionEnd(boolean isCanceled);
+    method @UiThread public void onTransitionEnd(boolean isCanceled);
   }
 
 }
@@ -465,7 +465,7 @@ package com.mapbox.navigation.ui.maps.camera.utils {
 
 package com.mapbox.navigation.ui.maps.camera.view {
 
-  public final class MapboxRecenterButton extends androidx.constraintlayout.widget.ConstraintLayout {
+  @UiThread public final class MapboxRecenterButton extends androidx.constraintlayout.widget.ConstraintLayout {
     ctor public MapboxRecenterButton(android.content.Context context);
     ctor public MapboxRecenterButton(android.content.Context context, android.util.AttributeSet? attrs);
     ctor public MapboxRecenterButton(android.content.Context context, android.util.AttributeSet? attrs, int defStyleAttr);
@@ -474,7 +474,7 @@ package com.mapbox.navigation.ui.maps.camera.view {
     method public void updateStyle(@StyleRes int style);
   }
 
-  public final class MapboxRouteOverviewButton extends androidx.constraintlayout.widget.ConstraintLayout {
+  @UiThread public final class MapboxRouteOverviewButton extends androidx.constraintlayout.widget.ConstraintLayout {
     ctor public MapboxRouteOverviewButton(android.content.Context context);
     ctor public MapboxRouteOverviewButton(android.content.Context context, android.util.AttributeSet? attrs);
     ctor public MapboxRouteOverviewButton(android.content.Context context, android.util.AttributeSet? attrs, int defStyleAttr);
@@ -513,7 +513,7 @@ package com.mapbox.navigation.ui.maps.guidance.junction.model {
 
 package com.mapbox.navigation.ui.maps.guidance.junction.view {
 
-  public final class MapboxJunctionView extends androidx.appcompat.widget.AppCompatImageView {
+  @UiThread public final class MapboxJunctionView extends androidx.appcompat.widget.AppCompatImageView {
     ctor public MapboxJunctionView(android.content.Context context);
     ctor public MapboxJunctionView(android.content.Context context, android.util.AttributeSet? attrs);
     ctor public MapboxJunctionView(android.content.Context context, android.util.AttributeSet? attrs, int defStyleAttr);
@@ -635,7 +635,7 @@ package com.mapbox.navigation.ui.maps.guidance.signboard.model {
 
 package com.mapbox.navigation.ui.maps.guidance.signboard.view {
 
-  public final class MapboxSignboardView extends androidx.appcompat.widget.AppCompatImageView {
+  @UiThread public final class MapboxSignboardView extends androidx.appcompat.widget.AppCompatImageView {
     ctor public MapboxSignboardView(android.content.Context context);
     ctor public MapboxSignboardView(android.content.Context context, android.util.AttributeSet? attrs);
     ctor public MapboxSignboardView(android.content.Context context, android.util.AttributeSet? attrs, int defStyleAttr);
@@ -734,7 +734,7 @@ package com.mapbox.navigation.ui.maps.roadname.model {
 
 package com.mapbox.navigation.ui.maps.roadname.view {
 
-  @Deprecated public final class MapboxRoadNameLabelView extends android.widget.LinearLayout {
+  @Deprecated @UiThread public final class MapboxRoadNameLabelView extends android.widget.LinearLayout {
     ctor @Deprecated public MapboxRoadNameLabelView(android.content.Context context);
     ctor @Deprecated public MapboxRoadNameLabelView(android.content.Context context, android.util.AttributeSet? attrs);
     ctor @Deprecated public MapboxRoadNameLabelView(android.content.Context context, android.util.AttributeSet? attrs, int defStyleAttr);
@@ -744,7 +744,7 @@ package com.mapbox.navigation.ui.maps.roadname.view {
     method @Deprecated public void updateRoadNameTextAppearance(@StyleRes int style);
   }
 
-  public final class MapboxRoadNameView extends androidx.appcompat.widget.AppCompatTextView {
+  @UiThread public final class MapboxRoadNameView extends androidx.appcompat.widget.AppCompatTextView {
     ctor public MapboxRoadNameView(android.content.Context context);
     ctor public MapboxRoadNameView(android.content.Context context, android.util.AttributeSet? attrs);
     ctor public MapboxRoadNameView(android.content.Context context, android.util.AttributeSet? attrs, int defStyleAttr);
@@ -778,7 +778,7 @@ package com.mapbox.navigation.ui.maps.route.arrow.api {
     method public com.mapbox.navigation.ui.maps.route.arrow.model.ArrowVisibilityChangeValue showManeuverArrow();
   }
 
-  public final class MapboxRouteArrowView {
+  @UiThread public final class MapboxRouteArrowView {
     ctor public MapboxRouteArrowView(com.mapbox.navigation.ui.maps.route.arrow.model.RouteArrowOptions options);
     method public com.mapbox.maps.extension.style.layers.properties.generated.Visibility? getVisibility(com.mapbox.maps.Style style);
     method public void render(com.mapbox.maps.Style style, com.mapbox.navigation.ui.maps.route.arrow.model.ArrowVisibilityChangeValue visibilityChange);
@@ -933,7 +933,7 @@ package com.mapbox.navigation.ui.maps.route.line.api {
   public static final class MapboxRouteLineApi.Companion {
   }
 
-  public final class MapboxRouteLineView {
+  @UiThread public final class MapboxRouteLineView {
     ctor public MapboxRouteLineView(com.mapbox.navigation.ui.maps.route.line.model.MapboxRouteLineOptions options);
     method public void cancel();
     method public com.mapbox.maps.extension.style.layers.properties.generated.Visibility? getAlternativeRoutesVisibility(com.mapbox.maps.Style style);
@@ -1410,15 +1410,15 @@ package com.mapbox.navigation.ui.maps.util {
   }
 
   public final class ViewUtils {
-    method public static void capture(android.view.View, com.mapbox.navigation.ui.maps.util.OnViewScreenshotReady callback);
+    method @UiThread public static void capture(android.view.View, com.mapbox.navigation.ui.maps.util.OnViewScreenshotReady callback);
     field public static final com.mapbox.navigation.ui.maps.util.ViewUtils INSTANCE;
   }
 
 }
 
 package com.mapbox.navigation.ui.maps.view {
 
-  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class MapboxCameraModeButton extends android.widget.FrameLayout {
+  @UiThread @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class MapboxCameraModeButton extends android.widget.FrameLayout {
     ctor public MapboxCameraModeButton(android.content.Context context);
     ctor public MapboxCameraModeButton(android.content.Context context, android.util.AttributeSet? attrs);
     ctor public MapboxCameraModeButton(android.content.Context context, android.util.AttributeSet? attrs, int defStyleAttr);
@@ -1434,9 +1434,9 @@ package com.mapbox.navigation.ui.maps.view {
     method public void setFollowingText(String?);
     method public void setOverviewIconResId(int);
     method public void setOverviewText(String?);
-    method @UiThread public void setState(com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState state);
-    method @UiThread public void setStateAndExtend(com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState state, long duration = 2000L);
-    method @UiThread public void setStateAndExtend(com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState state);
+    method public void setState(com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState state);
+    method public void setStateAndExtend(com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState state, long duration = 2000L);
+    method public void setStateAndExtend(com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState state);
     method public void updateStyle(@StyleRes int style);
     property public final androidx.constraintlayout.widget.ConstraintLayout containerView;
     property public final int followingIconResId;

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/PredictiveCacheController.kt

@@ -1,5 +1,6 @@
 package com.mapbox.navigation.ui.maps
 
+import androidx.annotation.UiThread
 import com.mapbox.bindgen.Expected
 import com.mapbox.bindgen.Value
 import com.mapbox.common.TileStore
@@ -57,6 +58,7 @@ private const val RASTER_SOURCE_TYPE = "raster"
  *
  * @param predictiveCacheOptions [PredictiveCacheOptions] options to instantiate instance of [PredictiveCacheController]
  */
+@UiThread
 class PredictiveCacheController constructor(
     private val predictiveCacheOptions: PredictiveCacheOptions,
 ) {

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/building/view/MapboxBuildingView.kt

@@ -1,5 +1,6 @@
 package com.mapbox.navigation.ui.maps.building.view
 
+import androidx.annotation.UiThread
 import com.mapbox.maps.MapboxExperimental
 import com.mapbox.maps.MapboxMap
 import com.mapbox.maps.QueriedFeature
@@ -21,6 +22,7 @@ import com.mapbox.navigation.ui.maps.building.model.MapboxBuildingHighlightOptio
  * This means that if the data has not changed, it does not have to be manually redrawn after a style change.
  * See [Style.addPersistentStyleLayer].
  */
+@UiThread
 class MapboxBuildingView {
 
     /**

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/camera/data/ViewportDataSourceUpdateObserver.kt

@@ -1,5 +1,7 @@
 package com.mapbox.navigation.ui.maps.camera.data
 
+import androidx.annotation.UiThread
+
 /**
  * Observer that gets notified whenever [ViewportData] changes.
  */
@@ -9,5 +11,6 @@ fun interface ViewportDataSourceUpdateObserver {
      * Called whenever [ViewportData] changes.
      * @param viewportData latest data
      */
+    @UiThread
     fun viewportDataSourceUpdated(viewportData: ViewportData)
 }

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/camera/lifecycle/NavigationScaleGestureHandler.kt

@@ -2,6 +2,7 @@ package com.mapbox.navigation.ui.maps.camera.lifecycle
 
 import android.animation.ValueAnimator
 import android.content.Context
+import androidx.annotation.UiThread
 import com.mapbox.android.gestures.AndroidGesturesManager
 import com.mapbox.android.gestures.MoveGestureDetector
 import com.mapbox.geojson.Point
@@ -281,6 +282,7 @@ class NavigationScaleGestureHandler(
      *
      * @see cleanup
      */
+    @UiThread
     fun initialize() {
         gesturesPlugin.setGesturesManager(
             customGesturesManager,
@@ -306,6 +308,7 @@ class NavigationScaleGestureHandler(
      *
      * @see initialize
      */
+    @UiThread
     fun cleanup() {
         gesturesPlugin.setGesturesManager(
             initialGesturesManager,

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/camera/state/NavigationCameraStateChangedObserver.kt

@@ -1,5 +1,7 @@
 package com.mapbox.navigation.ui.maps.camera.state
 
+import androidx.annotation.UiThread
+
 /**
  * Observer that gets notified whenever [NavigationCameraState] changes.
  */
@@ -9,5 +11,6 @@ fun interface NavigationCameraStateChangedObserver {
      * Called whenever [NavigationCameraState] changes.
      * @param navigationCameraState current states
      */
+    @UiThread
     fun onNavigationCameraStateChanged(navigationCameraState: NavigationCameraState)
 }

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/camera/transition/NavigationCameraStateTransition.kt

@@ -1,11 +1,13 @@
 package com.mapbox.navigation.ui.maps.camera.transition
 
 import android.animation.AnimatorSet
+import androidx.annotation.UiThread
 import com.mapbox.maps.CameraOptions
 
 /**
  * Helper interface to provide navigation camera state transitions.
  */
+@UiThread
 interface NavigationCameraStateTransition {
     /**
      * Transition the camera to following state.

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/camera/transition/NavigationCameraTransition.kt

@@ -1,11 +1,13 @@
 package com.mapbox.navigation.ui.maps.camera.transition
 
 import android.animation.AnimatorSet
+import androidx.annotation.UiThread
 import com.mapbox.maps.CameraOptions
 
 /**
  * Helper interface to provide camera transition animations.
  */
+@UiThread
 interface NavigationCameraTransition {
     /**
      * This transition moves the camera from a zoomed out level to a zoomed in level.

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/camera/transition/TransitionEndListener.kt

@@ -1,5 +1,6 @@
 package com.mapbox.navigation.ui.maps.camera.transition
 
+import androidx.annotation.UiThread
 import com.mapbox.navigation.ui.maps.camera.NavigationCamera
 
 /**
@@ -12,5 +13,6 @@ fun interface TransitionEndListener {
      *
      * @param isCanceled whether the transition was canceled.
      */
+    @UiThread
     fun onTransitionEnd(isCanceled: Boolean)
 }