From 30f9b6ffdc4a7ee1398bed8d34a988c38f2bb0b1 Mon Sep 17 00:00:00 2001
From: Dennis Guse <dennis.guse@alumni.tu-berlin.de>
Date: Fri, 28 Jan 2022 22:22:10 +0100
Subject: [PATCH] Cleanup in VoiceAnnouncement: rename to start() and stop().

---
 .../announcement/VoiceAnnouncementManagerTest.java     |  8 ++++----
 .../opentracks/services/TrackRecordingService.java     |  9 +++------
 .../services/announcement/VoiceAnnouncement.java       |  2 +-
 .../announcement/VoiceAnnouncementManager.java         | 10 +++++-----
 4 files changed, 13 insertions(+), 16 deletions(-)

diff --git a/src/androidTest/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncementManagerTest.java b/src/androidTest/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncementManagerTest.java
index 712eee626..f6f5d6b95 100644
--- a/src/androidTest/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncementManagerTest.java
+++ b/src/androidTest/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncementManagerTest.java
@@ -60,11 +60,11 @@ public class VoiceAnnouncementManagerTest {
         // when
         TrackStatistics statistics = new TrackStatistics();
         statistics.setTotalDistance(Distance.ofKilometer(13));
-        voiceAnnouncementManager.restore(statistics);
+        voiceAnnouncementManager.start(statistics);
         assertEquals(Distance.of(15000), voiceAnnouncementManager.getNextTotalDistance());
 
         statistics.setTotalDistance(Distance.of(15100));
-        voiceAnnouncementManager.restore(statistics);
+        voiceAnnouncementManager.start(statistics);
         assertEquals(Distance.of(20000), voiceAnnouncementManager.getNextTotalDistance());
     }
 
@@ -80,11 +80,11 @@ public class VoiceAnnouncementManagerTest {
         // when
         TrackStatistics statistics = new TrackStatistics();
         statistics.setTotalTime(Duration.ofSeconds(91));
-        voiceAnnouncementManager.restore(statistics);
+        voiceAnnouncementManager.start(statistics);
         assertEquals(Duration.ofSeconds(95), voiceAnnouncementManager.getNextTotalTime());
 
         statistics.setTotalTime(Duration.ofSeconds(95));
-        voiceAnnouncementManager.restore(statistics);
+        voiceAnnouncementManager.start(statistics);
         assertEquals(Duration.ofSeconds(100), voiceAnnouncementManager.getNextTotalTime());
     }
 
diff --git a/src/main/java/de/dennisguse/opentracks/services/TrackRecordingService.java b/src/main/java/de/dennisguse/opentracks/services/TrackRecordingService.java
index cf3f3bfaa..c85c359c7 100644
--- a/src/main/java/de/dennisguse/opentracks/services/TrackRecordingService.java
+++ b/src/main/java/de/dennisguse/opentracks/services/TrackRecordingService.java
@@ -135,7 +135,7 @@ public class TrackRecordingService extends Service implements TrackPointCreator.
 
         egm2008CorrectionManager = null;
         try {
-            voiceAnnouncementManager.shutdown();
+            voiceAnnouncementManager.stop();
         } finally {
             voiceAnnouncementManager = null;
         }
@@ -194,16 +194,13 @@ public class TrackRecordingService extends Service implements TrackPointCreator.
         resumeTrack(recordingStatus.getTrackId());
     }
 
-    /**
-     * Common code for starting a new track or resuming a track.
-     */
     private void startRecording() {
         // Update instance variables
         handler.postDelayed(updateRecordingData, RECORDING_DATA_UPDATE_INTERVAL.toMillis());
 
         startSensors();
 
-        voiceAnnouncementManager.restore(trackRecordingManager.getTrackStatistics());
+        voiceAnnouncementManager.start(trackRecordingManager.getTrackStatistics());
     }
 
     public void tryStartSensors() {
@@ -267,7 +264,7 @@ public class TrackRecordingService extends Service implements TrackPointCreator.
             recordingDataObservable.postValue(NOT_RECORDING);
         }
 
-        voiceAnnouncementManager.shutdown();
+        voiceAnnouncementManager.stop();
 
         // Update instance variables
         trackPointCreator.stop();
diff --git a/src/main/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncement.java b/src/main/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncement.java
index 886f733a8..7240cebcf 100644
--- a/src/main/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncement.java
+++ b/src/main/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncement.java
@@ -178,7 +178,7 @@ public class VoiceAnnouncement {
         tts.speak(announcement, TextToSpeech.QUEUE_FLUSH, null, "not used");
     }
 
-    public void shutdown() {
+    public void stop() {
         if (tts != null) {
             tts.shutdown();
             tts = null;
diff --git a/src/main/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncementManager.java b/src/main/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncementManager.java
index aa52f5ef3..993cc379a 100644
--- a/src/main/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncementManager.java
+++ b/src/main/java/de/dennisguse/opentracks/services/announcement/VoiceAnnouncementManager.java
@@ -61,7 +61,7 @@ public class VoiceAnnouncementManager implements SharedPreferences.OnSharedPrefe
         PreferencesUtils.registerOnSharedPreferenceChangeListener(this);
     }
 
-    public void restore(@Nullable TrackStatistics trackStatistics) {
+    public void start(@Nullable TrackStatistics trackStatistics) {
         voiceAnnouncement = new VoiceAnnouncement(trackRecordingService);
         voiceAnnouncement.start();
 
@@ -92,22 +92,22 @@ public class VoiceAnnouncementManager implements SharedPreferences.OnSharedPrefe
         }
     }
 
-    public void shutdown() {
+    public void stop() {
         PreferencesUtils.unregisterOnSharedPreferenceChangeListener(this);
         if (voiceAnnouncement != null) {
-            voiceAnnouncement.shutdown();
+            voiceAnnouncement.stop();
             voiceAnnouncement = null;
         }
     }
 
     public void setFrequency(Duration frequency) {
         this.totalTimeFrequency = frequency;
-        restore(this.trackStatistics);
+        start(this.trackStatistics);
     }
 
     public void setFrequency(Distance frequency) {
         this.distanceFrequency = frequency;
-        restore(this.trackStatistics);
+        start(this.trackStatistics);
     }
 
     public void updateNextTaskDistance() {