mark core classes with UIThread annotation

Author: dzinad

CHANGELOG.md

@@ -5,6 +5,7 @@ Mapbox welcomes participation and contributions from everyone.
 ## Unreleased
 #### Features
 #### Bug fixes and improvements
+- Marked `ReplayProgressObserver`, `MapboxReplayer`, `ReplayLocationEngine`, `RerouteController#RoutesCallback`, `NavigationRerouteController#RoutesCallback`, `LocationObserver`, `NavigationSessionStateObserver`, `OffRouteObserver`, `RouteProgressObserver`, `TripSessionStateObserver`, `VoiceInstructionsObserver` methods with `@UiThread` annotation. [#6266](https://github.com/mapbox/mapbox-navigation-android/pull/6266)
 
 ## Mapbox Navigation SDK 2.9.0-alpha.3 - 23 September, 2022
 ### Changelog
@@ -65,7 +66,6 @@ This release depends on, and has been tested with, the following Mapbox dependen
 - Mapbox Android Core `v5.0.2` ([release notes](https://github.com/mapbox/mapbox-events-android/releases/tag/core-5.0.2))
 - Mapbox Android Telemetry `v8.1.5` ([release notes](https://github.com/mapbox/mapbox-events-android/releases/tag/telem-8.1.5-core-5.0.2))
 
-
 ## Mapbox Navigation SDK 2.9.0-alpha.2 - 16 September, 2022
 ### Changelog
 [Changes between v2.9.0-alpha.1 and v2.9.0-alpha.2](https://github.com/mapbox/mapbox-navigation-android/compare/v2.9.0-alpha.1...v2.9.0-alpha.2)

libnavigation-core/api/current.txt

@@ -374,7 +374,7 @@ package com.mapbox.navigation.core.navigator {
 
 package com.mapbox.navigation.core.replay {
 
-  public final class MapboxReplayer {
+  @UiThread public final class MapboxReplayer {
     ctor public MapboxReplayer();
     method public void clearEvents();
     method public double durationSeconds();
@@ -394,7 +394,7 @@ package com.mapbox.navigation.core.replay {
     method public void unregisterObservers();
   }
 
-  public final class ReplayLocationEngine implements com.mapbox.android.core.location.LocationEngine com.mapbox.navigation.core.replay.history.ReplayEventsObserver {
+  @UiThread public final class ReplayLocationEngine implements com.mapbox.android.core.location.LocationEngine com.mapbox.navigation.core.replay.history.ReplayEventsObserver {
     ctor public ReplayLocationEngine(com.mapbox.navigation.core.replay.MapboxReplayer mapboxReplayer);
     method public void getLastLocation(com.mapbox.android.core.location.LocationEngineCallback<com.mapbox.android.core.location.LocationEngineResult> callback);
     method public void removeLocationUpdates(com.mapbox.android.core.location.LocationEngineCallback<com.mapbox.android.core.location.LocationEngineResult> callback);
@@ -527,7 +527,7 @@ package com.mapbox.navigation.core.replay.route {
     ctor public ReplayProgressObserver(com.mapbox.navigation.core.replay.MapboxReplayer mapboxReplayer, com.mapbox.navigation.core.replay.route.ReplayRouteMapper replayRouteMapper = com.mapbox.navigation.core.replay.route.ReplayRouteMapper());
     ctor public ReplayProgressObserver(com.mapbox.navigation.core.replay.MapboxReplayer mapboxReplayer);
     method public void onRouteProgressChanged(com.mapbox.navigation.base.trip.model.RouteProgress routeProgress);
-    method public com.mapbox.navigation.core.replay.route.ReplayProgressObserver updateOptions(com.mapbox.navigation.core.replay.route.ReplayRouteOptions options);
+    method @UiThread public com.mapbox.navigation.core.replay.route.ReplayProgressObserver updateOptions(com.mapbox.navigation.core.replay.route.ReplayRouteOptions options);
   }
 
   public final class ReplayRouteMapper {
@@ -583,15 +583,15 @@ package com.mapbox.navigation.core.replay.route {
 
 package com.mapbox.navigation.core.reroute {
 
-  public interface NavigationRerouteController extends com.mapbox.navigation.core.reroute.RerouteController {
+  @UiThread public interface NavigationRerouteController extends com.mapbox.navigation.core.reroute.RerouteController {
     method public void reroute(com.mapbox.navigation.core.reroute.NavigationRerouteController.RoutesCallback callback);
   }
 
-  public static fun interface NavigationRerouteController.RoutesCallback {
+  @UiThread public static fun interface NavigationRerouteController.RoutesCallback {
     method public void onNewRoutes(java.util.List<com.mapbox.navigation.base.route.NavigationRoute> routes, com.mapbox.navigation.base.route.RouterOrigin routerOrigin);
   }
 
-  public interface RerouteController {
+  @UiThread public interface RerouteController {
     method public com.mapbox.navigation.core.reroute.RerouteState getState();
     method public void interrupt();
     method public boolean registerRerouteStateObserver(com.mapbox.navigation.core.reroute.RerouteController.RerouteStateObserver rerouteStateObserver);
@@ -604,7 +604,7 @@ package com.mapbox.navigation.core.reroute {
     method public void onRerouteStateChanged(com.mapbox.navigation.core.reroute.RerouteState rerouteState);
   }
 
-  public static fun interface RerouteController.RoutesCallback {
+  @UiThread public static fun interface RerouteController.RoutesCallback {
     method public void onNewRoutes(java.util.List<? extends com.mapbox.api.directions.v5.models.DirectionsRoute> routes);
   }
 
@@ -930,7 +930,7 @@ package com.mapbox.navigation.core.trip.session {
     property public final Integer? zLevel;
   }
 
-  public interface LocationObserver {
+  @UiThread public interface LocationObserver {
     method public void onNewLocationMatcherResult(com.mapbox.navigation.core.trip.session.LocationMatcherResult locationMatcherResult);
     method public void onNewRawLocation(android.location.Location rawLocation);
   }
@@ -960,19 +960,19 @@ package com.mapbox.navigation.core.trip.session {
     field public static final com.mapbox.navigation.core.trip.session.NavigationSessionState.Idle INSTANCE;
   }
 
-  public fun interface NavigationSessionStateObserver {
+  @UiThread public fun interface NavigationSessionStateObserver {
     method public void onNavigationSessionStateChanged(com.mapbox.navigation.core.trip.session.NavigationSessionState navigationSession);
   }
 
-  public fun interface OffRouteObserver {
+  @UiThread public fun interface OffRouteObserver {
     method public void onOffRouteStateChanged(boolean offRoute);
   }
 
   @Deprecated public fun interface RoadObjectsOnRouteObserver {
     method @Deprecated public void onNewRoadObjectsOnTheRoute(java.util.List<com.mapbox.navigation.base.trip.model.roadobject.UpcomingRoadObject> roadObjects);
   }
 
-  public fun interface RouteProgressObserver {
+  @UiThread public fun interface RouteProgressObserver {
     method public void onRouteProgressChanged(com.mapbox.navigation.base.trip.model.RouteProgress routeProgress);
   }
 
@@ -981,11 +981,11 @@ package com.mapbox.navigation.core.trip.session {
     enum_constant public static final com.mapbox.navigation.core.trip.session.TripSessionState STOPPED;
   }
 
-  public fun interface TripSessionStateObserver {
+  @UiThread public fun interface TripSessionStateObserver {
     method public void onSessionStateChanged(com.mapbox.navigation.core.trip.session.TripSessionState tripSessionState);
   }
 
-  public fun interface VoiceInstructionsObserver {
+  @UiThread public fun interface VoiceInstructionsObserver {
     method public void onNewVoiceInstructions(com.mapbox.api.directions.v5.models.VoiceInstructions voiceInstructions);
   }
 

libnavigation-core/src/main/java/com/mapbox/navigation/core/replay/MapboxReplayer.kt

@@ -4,6 +4,7 @@ import android.Manifest.permission.ACCESS_COARSE_LOCATION
 import android.Manifest.permission.ACCESS_FINE_LOCATION
 import android.content.Context
 import androidx.annotation.RequiresPermission
+import androidx.annotation.UiThread
 import com.mapbox.android.core.location.LocationEngine
 import com.mapbox.android.core.location.LocationEngineCallback
 import com.mapbox.android.core.location.LocationEngineProvider
@@ -20,6 +21,7 @@ import java.util.Collections.singletonList
 /**
  * This class is similar to a music player. It will include controls like play, pause, seek.
  */
+@UiThread
 class MapboxReplayer {
 
     private val replayEvents = ReplayEvents(mutableListOf())

libnavigation-core/src/main/java/com/mapbox/navigation/core/replay/ReplayLocationEngine.kt

@@ -4,6 +4,7 @@ import android.app.PendingIntent
 import android.location.Location
 import android.os.Looper
 import android.os.SystemClock
+import androidx.annotation.UiThread
 import com.mapbox.android.core.location.LocationEngine
 import com.mapbox.android.core.location.LocationEngineCallback
 import com.mapbox.android.core.location.LocationEngineRequest
@@ -19,6 +20,7 @@ private typealias EngineCallback = LocationEngineCallback<LocationEngineResult>
 /**
  * Location Engine for replaying route history.
  */
+@UiThread
 class ReplayLocationEngine(
     private val mapboxReplayer: MapboxReplayer
 ) : LocationEngine, ReplayEventsObserver {

libnavigation-core/src/main/java/com/mapbox/navigation/core/replay/route/ReplayProgressObserver.kt

@@ -1,5 +1,6 @@
 package com.mapbox.navigation.core.replay.route
 
+import androidx.annotation.UiThread
 import com.mapbox.api.directions.v5.models.RouteLeg
 import com.mapbox.geojson.Point
 import com.mapbox.navigation.base.trip.model.RouteProgress
@@ -31,6 +32,7 @@ class ReplayProgressObserver @JvmOverloads constructor(
      * @param options allow you to control the driver and car behavior.
      * @return [ReplayProgressObserver]
      */
+    @UiThread
     fun updateOptions(options: ReplayRouteOptions): ReplayProgressObserver {
         replayRouteMapper.options = options
         return this

libnavigation-core/src/main/java/com/mapbox/navigation/core/reroute/NavigationRerouteController.kt

@@ -1,5 +1,6 @@
 package com.mapbox.navigation.core.reroute
 
+import androidx.annotation.UiThread
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.route.RouterOrigin
 import com.mapbox.navigation.core.MapboxNavigation
@@ -9,6 +10,7 @@ import com.mapbox.navigation.core.trip.session.OffRouteObserver
  * Reroute controller allows changing the reroute logic externally. Use [MapboxNavigation.rerouteController]
  * to replace it.
  */
+@UiThread
 interface NavigationRerouteController : RerouteController {
 
     /**
@@ -23,6 +25,7 @@ interface NavigationRerouteController : RerouteController {
      * Route Callback is useful to set new route(s) on reroute event. Doing the same as
      * [MapboxNavigation.setRoutes].
      */
+    @UiThread
     fun interface RoutesCallback {
         /**
          * Called whenever new route(s) has been fetched.

libnavigation-core/src/main/java/com/mapbox/navigation/core/reroute/RerouteController.kt

@@ -1,5 +1,6 @@
 package com.mapbox.navigation.core.reroute
 
+import androidx.annotation.UiThread
 import com.mapbox.api.directions.v5.models.DirectionsRoute
 import com.mapbox.navigation.base.route.RouterFailure
 import com.mapbox.navigation.base.route.RouterOrigin
@@ -11,6 +12,7 @@ import com.mapbox.navigation.core.trip.session.OffRouteObserver
  * Reroute controller allows changing the reroute logic externally. Use [MapboxNavigation.rerouteController]
  * to replace it.
  */
+@UiThread
 interface RerouteController {
 
     /**
@@ -51,6 +53,7 @@ interface RerouteController {
      * Route Callback is useful to set new route(s) on reroute event. Doing the same as
      * [MapboxNavigation.setRoutes].
      */
+    @UiThread
     fun interface RoutesCallback {
         /**
          * Called whenever new route(s) has been fetched.

libnavigation-core/src/main/java/com/mapbox/navigation/core/trip/session/LocationObserver.kt

@@ -1,12 +1,14 @@
 package com.mapbox.navigation.core.trip.session
 
 import android.location.Location
+import androidx.annotation.UiThread
 
 /**
  * An interface which enables listening to location updates
  *
  * @see [LocationMatcherResult]
  */
+@UiThread
 interface LocationObserver {
 
     /**

libnavigation-core/src/main/java/com/mapbox/navigation/core/trip/session/NavigationSessionStateObserver.kt

@@ -1,10 +1,13 @@
 package com.mapbox.navigation.core.trip.session
 
+import androidx.annotation.UiThread
+
 /**
  * Callback that provides the various session states that can happen within a navigation session
  *
  * @see NavigationSessionState
  */
+@UiThread
 fun interface NavigationSessionStateObserver {
     /**
      * Called whenever the navigation session state has changed

libnavigation-core/src/main/java/com/mapbox/navigation/core/trip/session/OffRouteObserver.kt

@@ -1,11 +1,13 @@
 package com.mapbox.navigation.core.trip.session
 
+import androidx.annotation.UiThread
 import com.mapbox.navigation.core.MapboxNavigation
 
 /**
  * This interface is for turn-by-turn route navigation, but not in free-drive mode.
  * This interface can be registered via a [MapboxNavigation] object.
  */
+@UiThread
 fun interface OffRouteObserver {
     /**
      * Called whenever the user is off route