app/src/main/java/com/a1/nextlocation/data/RouteHandler.java

@@ -1,5 +1,7 @@
 package com.a1.nextlocation.data;
 
+import org.osmdroid.views.overlay.Polyline;
+
 /**
  * singleton to track the current route that is being followed
  */
@@ -9,6 +11,21 @@ public enum RouteHandler {
     private boolean isFollowingRoute = false;
     private Route currentRoute;
     private int stepCount = 0;
+    private RouteFinishedListener routeFinishedListener;
+
+    private Polyline currentRouteLine;
+
+    public void setCurrentRouteLine(Polyline currentRouteLine) {
+        this.currentRouteLine = currentRouteLine;
+    }
+
+    public Polyline getCurrentRouteLine() {
+        return currentRouteLine;
+    }
+
+    public void setRouteFinishedListener(RouteFinishedListener routeFinishedListener) {
+        this.routeFinishedListener = routeFinishedListener;
+    }
 
     public int getStepCount() {
         return stepCount;
@@ -22,6 +39,7 @@ public enum RouteHandler {
         stepCount = 0;
         isFollowingRoute = false;
         currentRoute = null;
+        currentRouteLine = null;
     }
 
     public void followRoute(Route route) {
@@ -39,4 +57,13 @@ public enum RouteHandler {
     public boolean isFollowingRoute() {
         return isFollowingRoute;
     }
+
+    public Route getCurrentRoute() {
+        return currentRoute;
+    }
+
+    @FunctionalInterface
+    public interface RouteFinishedListener {
+        void onRouteFinish();
+    }
 }

app/src/main/java/com/a1/nextlocation/data/StaticData.java

@@ -34,14 +34,6 @@ public enum StaticData {
         return locationsVisited;
     }
 
-    private Polyline currentRoute;
 
-    public void setCurrentRoute(Polyline currentRoute) {
-        this.currentRoute = currentRoute;
-    }
-
-    public Polyline getCurrentRoute() {
-        return currentRoute;
-    }
 
 }

app/src/main/java/com/a1/nextlocation/fragments/HomeFragment.java

@@ -1,7 +1,6 @@
 package com.a1.nextlocation.fragments;
 
 
-
 import android.Manifest;
 import android.content.Context;
 import android.content.pm.PackageManager;
@@ -25,6 +24,7 @@ import androidx.fragment.app.Fragment;
 import androidx.fragment.app.FragmentActivity;
 
 import com.a1.nextlocation.R;
+import com.a1.nextlocation.data.RouteHandler;
 import com.a1.nextlocation.data.StaticData;
 import com.a1.nextlocation.json.DirectionsResult;
 import com.a1.nextlocation.network.ApiHandler;
@@ -50,6 +50,7 @@ public class HomeFragment extends Fragment implements LocationListener{
     private final String userAgent = "com.ai.nextlocation.fragments";
     public final static String MAPQUEST_API_KEY = "vuyXjqnAADpjeL9QwtgWGleIk95e36My";
     private ImageButton imageButton;
+    private ImageButton stopButton;
     private MapView mapView;
     private final int REQUEST_PERMISSIONS_REQUEST_CODE = 1;
     private final String TAG = HomeFragment.class.getCanonicalName();
@@ -57,6 +58,7 @@ public class HomeFragment extends Fragment implements LocationListener{
     private Polyline roadOverlay;
     private int color;
     private Location currentLocation;
+    private Overlay allLocationsOverlay;
 
     @Override
     public void onCreate(Bundle savedInstanceState) {
@@ -84,6 +86,23 @@ public class HomeFragment extends Fragment implements LocationListener{
             ((FragmentActivity) view.getContext()).getSupportFragmentManager().beginTransaction().replace(R.id.fragment_layout, locationFragment).addToBackStack(null).commit();
         });
 
+        stopButton = view.findViewById(R.id.home_stop_route_button);
+        stopButton.setOnClickListener(v -> {
+            RouteHandler.INSTANCE.finishRoute();
+            stopButton.setVisibility(View.GONE);
+            Toast.makeText(requireContext(),getResources().getString(R.string.route_stop_toast),Toast.LENGTH_SHORT).show();
+            mapView.getOverlays().remove(roadOverlay);
+            mapView.getOverlays().remove(allLocationsOverlay);
+            addLocations();
+            mapView.invalidate();
+            roadOverlay = null;
+        });
+
+        if (RouteHandler.INSTANCE.isFollowingRoute()) {
+            stopButton.setVisibility(View.VISIBLE);
+        } else {
+            stopButton.setVisibility(View.GONE);
+        }
         ApiHandler.INSTANCE.addListener(this::onDirectionsAvailable);
         return view;
     }
@@ -103,7 +122,7 @@ public class HomeFragment extends Fragment implements LocationListener{
         roadOverlay.setColor(color);
 
 
-        StaticData.INSTANCE.setCurrentRoute(roadOverlay);
+        RouteHandler.INSTANCE.setCurrentRouteLine(roadOverlay);
         Log.d(TAG, "onDirectionsAvailable: successfully added road!");
 
     }
@@ -117,6 +136,7 @@ public class HomeFragment extends Fragment implements LocationListener{
 
     /**
      * This method initializes the map and all the things it needs
+     *
      * @param view the view the map is on
      */
     private void initMap(@NonNull View view) {
@@ -153,8 +173,6 @@ public class HomeFragment extends Fragment implements LocationListener{
         LocationManager locationManager = (LocationManager) requireActivity().getSystemService(Context.LOCATION_SERVICE);
 
 
-
-
         try {
 
             locationManager.requestLocationUpdates(LocationManager.GPS_PROVIDER, 0, 0, this);
@@ -188,9 +206,10 @@ public class HomeFragment extends Fragment implements LocationListener{
 
     private void displayRoute() {
 
+        if (RouteHandler.INSTANCE.isFollowingRoute()) {
             if (roadOverlay == null) {
-            if (StaticData.INSTANCE.getCurrentRoute() != null) {
+                if (RouteHandler.INSTANCE.getCurrentRouteLine() != null) {
-                roadOverlay = StaticData.INSTANCE.getCurrentRoute();
+                    roadOverlay = RouteHandler.INSTANCE.getCurrentRouteLine();
                     mapView.getOverlays().add(roadOverlay);
                     mapView.invalidate();
                     Log.d(TAG, "initMap: successfully added road!");
@@ -201,9 +220,10 @@ public class HomeFragment extends Fragment implements LocationListener{
                 Log.d(TAG, "initMap: successfully added road!");
             }
         }
+    }
 
     private void addLocations() {
-        List<com.a1.nextlocation.data.Location> locations = LocationListManager.INSTANCE.getLocationList();
+        List<com.a1.nextlocation.data.Location> locations = RouteHandler.INSTANCE.isFollowingRoute() ? RouteHandler.INSTANCE.getCurrentRoute().getLocations() : LocationListManager.INSTANCE.getLocationList();
         final ArrayList<OverlayItem> items = new ArrayList<>(locations.size());
         Drawable marker = ContextCompat.getDrawable(requireContext(), R.drawable.ic_baseline_location_on_24);
         marker.setAlpha(255);
@@ -213,7 +233,7 @@ public class HomeFragment extends Fragment implements LocationListener{
             item.setMarker(marker);
             items.add(item);
         }
-        Overlay allLocationsOverlay = new ItemizedIconOverlay<OverlayItem>(items,
+        allLocationsOverlay = new ItemizedIconOverlay<OverlayItem>(items,
                 new ItemizedIconOverlay.OnItemGestureListener<OverlayItem>() {
                     @Override
                     public boolean onItemSingleTapUp(int index, OverlayItem item) {

app/src/main/res/drawable-anydpi/ic_stop_icon.xml

@@ -0,0 +1,12 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="#333333"
+    android:alpha="0.6">
+  <path
+      android:fillColor="@android:color/white"
+      android:pathData="M8,16h8V8H8V16zM12,2C6.48,2 2,6.48 2,12s4.48,10 10,10s10,-4.48 10,-10S17.52,2 12,2L12,2z"
+      android:fillType="evenOdd"/>
+</vector>

app/src/main/res/layout/fragment_home.xml

@@ -27,6 +27,17 @@
             android:src="@drawable/ic_baseline_outlined_flag_24"
             app:layout_constraintEnd_toEndOf="parent"
             app:layout_constraintTop_toTopOf="parent" />
+
+        <ImageButton
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:id="@+id/home_stop_route_button"
+            android:layout_marginTop="20dp"
+            android:layout_marginEnd="20dp"
+            app:layout_constraintEnd_toEndOf="parent"
+            app:layout_constraintTop_toBottomOf="@+id/location_list_button"
+            android:backgroundTint="@color/secondaryColour"
+            android:src="@drawable/ic_stop_icon"/>
     </androidx.constraintlayout.widget.ConstraintLayout>
 
 </FrameLayout>

app/src/main/res/values/strings.xml

@@ -17,4 +17,5 @@
     <string name="coupons_gespaard">Coupons gespaard:</string>
     <string name="coupons">Coupons</string>
     <string name="start_route">Start Route</string>
+    <string name="route_stop_toast">Route stopped!</string>
 </resources>