Rename to getRegisteredInstance

Author: kmadsen

CHANGELOG.md

@@ -13,6 +13,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Fixed an issue with restricted road visualization on the route line that occurred during route refreshes. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
 - Improved precision of restricted sections visualization, especially for long routes. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
 - Fixed a rare issue where alternative route would not be vanished until deviation point for `MapboxRouteLineApi#setNavigationRoutes(routes, metadata)` when the route's geometry contained duplicate points. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
+- Renamed `MapboxAudioGuidance.getInstance()` to `getRegisteredInstance`. [#6445](https://github.com/mapbox/mapbox-navigation-android/pull/6445)
 
 ## Mapbox Navigation SDK 2.9.0-alpha.4 - 30 September, 2022
 ### Changelog

libnavui-androidauto/src/main/java/com/mapbox/androidauto/navigation/audioguidance/AppAudioGuidanceUi.kt

@@ -19,7 +19,7 @@ fun Fragment.attachAudioGuidance(
     mapboxSoundButton: MapboxSoundButton
 ) {
     val lifecycleOwner = viewLifecycleOwner
-    val flow = MapboxAudioGuidance.getInstance().stateFlow()
+    val flow = MapboxAudioGuidance.getRegisteredInstance().stateFlow()
     lifecycleOwner.lifecycleScope.launch {
         lifecycleOwner.repeatOnLifecycle(Lifecycle.State.STARTED) {
             flow.collect { state ->
@@ -33,7 +33,7 @@ fun Fragment.attachAudioGuidance(
         }
     }
     mapboxSoundButton.setOnClickListener {
-        MapboxAudioGuidance.getInstance().toggle()
+        MapboxAudioGuidance.getRegisteredInstance().toggle()
     }
 }
 
@@ -45,15 +45,15 @@ fun Lifecycle.muteAudioGuidance() {
     addObserver(object : DefaultLifecycleObserver {
         lateinit var initialState: MapboxAudioGuidanceState
         override fun onResume(owner: LifecycleOwner) {
-            with(MapboxAudioGuidance.getInstance()) {
+            with(MapboxAudioGuidance.getRegisteredInstance()) {
                 initialState = stateFlow().value
                 mute()
             }
         }
 
         override fun onPause(owner: LifecycleOwner) {
             if (!initialState.isMuted) {
-                MapboxAudioGuidance.getInstance().unMute()
+                MapboxAudioGuidance.getRegisteredInstance().unMute()
             }
         }
     })

libnavui-androidauto/src/main/java/com/mapbox/androidauto/navigation/audioguidance/CarAudioGuidanceUi.kt

@@ -28,7 +28,7 @@ class CarAudioGuidanceUi : MapboxActionProvider.ScreenActionProvider {
      * Attach this to the screen while navigating.
      */
     private fun buildSoundButtonAction(screen: Screen): Action {
-        val audioGuidance = MapboxAudioGuidance.getInstance()
+        val audioGuidance = MapboxAudioGuidance.getRegisteredInstance()
         val state = audioGuidance.stateFlow().value
         return if (!state.isMuted) {
             buildIconAction(screen, R.drawable.mapbox_car_ic_volume_on) {
@@ -45,7 +45,7 @@ class CarAudioGuidanceUi : MapboxActionProvider.ScreenActionProvider {
         screen.lifecycle.apply {
             coroutineScope.launch {
                 repeatOnLifecycle(Lifecycle.State.STARTED) {
-                    MapboxAudioGuidance.getInstance().stateFlow()
+                    MapboxAudioGuidance.getRegisteredInstance().stateFlow()
                         .distinctUntilChanged { old, new ->
                             old.isMuted == new.isMuted && old.isPlayable == new.isPlayable
                         }

libnavui-app/src/main/java/com/mapbox/navigation/ui/app/internal/controller/AudioGuidanceStateController.kt

@@ -46,7 +46,7 @@ class AudioGuidanceStateController(
     override fun onAttached(mapboxNavigation: MapboxNavigation) {
         super.onAttached(mapboxNavigation)
 
-        val audioGuidance = MapboxAudioGuidance.getInstance()
+        val audioGuidance = MapboxAudioGuidance.getRegisteredInstance()
         audioGuidance.stateFlow().observe {
             if (it.isMuted != store.state.value.audio.isMuted) {
                 val newState = AudioGuidanceState(it.isMuted)

libnavui-app/src/test/java/com/mapbox/navigation/ui/app/internal/controller/AudioGuidanceStateControllerTest.kt

@@ -44,7 +44,7 @@ class AudioGuidanceStateControllerTest {
         mockAudioGuidance = mockk(relaxed = true) {
             every { stateFlow() } returns audioGuidanceState
         }
-        every { MapboxAudioGuidance.getInstance() } returns mockAudioGuidance
+        every { MapboxAudioGuidance.getRegisteredInstance() } returns mockAudioGuidance
 
         testStore = spyk(TestStore())
     }

libnavui-voice/api/current.txt

@@ -23,7 +23,7 @@ package com.mapbox.navigation.ui.voice.api {
 
   public final class MapboxAudioGuidance implements com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
     method public static com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance create();
-    method public static com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance getInstance();
+    method public static com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance getRegisteredInstance();
     method public void mute();
     method public void onAttached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
     method public void onDetached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
@@ -35,7 +35,7 @@ package com.mapbox.navigation.ui.voice.api {
 
   public static final class MapboxAudioGuidance.Companion {
     method public com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance create();
-    method public com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance getInstance();
+    method public com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance getRegisteredInstance();
   }
 
   public final class MapboxAudioGuidanceState {

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/MapboxAudioGuidance.kt

@@ -209,7 +209,7 @@ internal constructor(
          * Get the registered instance or create one and register it to [MapboxNavigationApp].
          */
         @JvmStatic
-        fun getInstance(): MapboxAudioGuidance = MapboxNavigationApp
+        fun getRegisteredInstance(): MapboxAudioGuidance = MapboxNavigationApp
             .getObservers(MapboxAudioGuidance::class)
             .firstOrNull() ?: create().also { MapboxNavigationApp.registerObserver(it) }
     }

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/internal/ui/AudioGuidanceButtonComponent.kt

@@ -52,7 +52,8 @@ class AudioGuidanceButtonComponent(
 
     init {
         this.contractProvider = contractProvider ?: Provider {
-            MapboxAudioComponentContract(coroutineScope, MapboxAudioGuidance.getInstance())
+            val mapboxAudioGuidance = MapboxAudioGuidance.getRegisteredInstance()
+            MapboxAudioComponentContract(coroutineScope, mapboxAudioGuidance)
         }
     }
 

qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/testing/JavaInterfaceChecker.java

@@ -10,7 +10,7 @@ class JavaInterfaceChecker {
   void MapboxAudioGuidance(
           CoroutineScope coroutineScope
   ) {
-    MapboxAudioGuidance sut = MapboxAudioGuidance.getInstance();
+    MapboxAudioGuidance sut = MapboxAudioGuidance.getRegisteredInstance();
     sut.mute();
     sut.unMute();
     sut.toggle();