- More simplifications of error handling, some refactors

Author: evtyz

pom.xml

@@ -172,11 +172,11 @@
                         <list>java.net.URL</list>
                         <list>stl.threebodysimulation.CanvasPanelFXMLController</list>
                         <list>stl.threebodysimulation.CanvasWrapper</list>
-                        <list>stl.threebodysimulation.WarningMessage</list>
+                        <list>stl.threebodysimulation.FilenameSpecificMessage</list>
                         <list>stl.threebodysimulation.DefaultSavePreviewFXMLController</list>
                         <list>stl.threebodysimulation.DefaultTemplates</list>
                         <list>stl.threebodysimulation.DesktopAPI</list>
-                        <list>stl.threebodysimulation.ErrorMessage</list>
+                        <list>stl.threebodysimulation.FilenameUnspecificMessage</list>
                         <list>stl.threebodysimulation.InfoFXMLController</list>
                         <list>stl.threebodysimulation.InfoPanelFXMLController</list>
                         <list>stl.threebodysimulation.Launcher</list>

src/main/java/stl/threebodysimulation/CanvasPanelFXMLController.java

@@ -135,7 +135,7 @@ public CanvasPanelFXMLController() {
      * @param filename The name of the CSV file to be setup
      * @return The path of the new CSV file.
      */
-    private static String setupCSV(String filename) {
+    private String setupCSV(String filename) {
         String filepath = String.format(SceneFXMLController.CSVFilePathTemplate, filename);
         File CSVDirectory = new File(SceneFXMLController.CSV_DIRECTORY_NAME);
         File CSVFile = new File(filepath);
@@ -148,6 +148,10 @@ private static String setupCSV(String filename) {
                     //noinspection ResultOfMethodCallIgnored : this should always return true, since it only runs if the file was successfully deleted.
                     CSVFile.createNewFile(); // And try creating the new file again.
                 } else {
+                    breakSimulation(new FilenameSpecificMessage(
+                            FilenameSpecificMessage.Type.OVERWRITE_ERROR,
+                            CSVFile.getAbsolutePath()
+                    ));
                     return "";
                 }
             }
@@ -232,7 +236,6 @@ void runSimulation(SimulationSettings settings) {
         } else {
             CSVFilePath = setupCSV(settings.getCSVFileName());
             if (CSVFilePath.equals("")) {
-                breakSimulation(ErrorMessage.OVERWRITE_ERROR);
                 return;
             }
         }
@@ -257,22 +260,22 @@ void runSimulation(SimulationSettings settings) {
             } catch (NumberIsTooSmallException e) {
                 // Asymptote error (the integrator can't converge and gives up)
                 System.out.println(e.getMessage());
-                breakSimulation(ErrorMessage.ASYMPTOTE_ERROR);
+                breakSimulationAfterUpdate(FilenameUnspecificMessage.ASYMPTOTE_ERROR);
                 return;
             } catch (NumberIsTooLargeException e) {
                 // Double overflow error (inputs too large for double datatype to handle)
                 System.out.println(e.getMessage());
-                breakSimulation(ErrorMessage.OVERFLOW_ERROR);
+                breakSimulationAfterUpdate(FilenameUnspecificMessage.OVERFLOW_ERROR);
                 return;
             } catch (Exception e) {
                 // Other errors
                 System.out.println(e.getMessage());
-                breakSimulation(ErrorMessage.UNKNOWN_ERROR);
+                breakSimulationAfterUpdate(FilenameUnspecificMessage.UNKNOWN_ERROR);
                 return;
             }
         }
 
-        double[][] scales = generateScale(particleDifferentialEquations, integrator, flattenedParticles.clone(), settings);
+        double[][] scales = generateScale(integrator, flattenedParticles.clone(), settings);
 
         updateParticles();
 
@@ -305,13 +308,12 @@ void runSimulation(SimulationSettings settings) {
     /**
      * Calculates the maximum and minimum x/y coordinates during the first ten seconds of simulation.
      *
-     * @param equations The differential equations.
      * @param integrator The integrator used.
      * @param particles The particles' initial states in flattened form.
      * @param settings The settings of the simulation.
      * @return The four corners of the smallest possible rectangle that all three particles do not escape in the first 10 seconds of simulation.
      */
-    private double[][] generateScale(ParticleDifferentialEquations equations, DormandPrince853Integrator integrator, double[] particles, SimulationSettings settings) {
+    private double[][] generateScale(DormandPrince853Integrator integrator, double[] particles, SimulationSettings settings) {
         final int SIMULATION_LENGTH = 10;
         double simulationTime = currentTime;
 
@@ -465,17 +467,17 @@ protected Void call() throws Exception {
                     } catch (NumberIsTooSmallException e) {
                         // Asymptote error catching
                         System.out.println(e.getMessage());
-                        Platform.runLater(() -> breakSimulation(ErrorMessage.ASYMPTOTE_ERROR));
+                        Platform.runLater(() -> breakSimulationAfterUpdate(FilenameUnspecificMessage.ASYMPTOTE_ERROR));
                         break;
                     } catch (NumberIsTooLargeException e) {
                         // Double overflow error catching.
                         System.out.println(e.getMessage());
-                        Platform.runLater(() -> breakSimulation(ErrorMessage.OVERFLOW_ERROR));
+                        Platform.runLater(() -> breakSimulationAfterUpdate(FilenameUnspecificMessage.OVERFLOW_ERROR));
                         break;
                     } catch (Exception e) {
                         // Other errors
                         System.out.println(e.getMessage());
-                        Platform.runLater(() -> breakSimulation(ErrorMessage.UNKNOWN_ERROR));
+                        Platform.runLater(() -> breakSimulationAfterUpdate(FilenameUnspecificMessage.UNKNOWN_ERROR));
                         break;
                     }
 
@@ -547,8 +549,12 @@ public void pausePressed() {
      *
      * @param errorMessage What error message to send to the user.
      */
-    private void breakSimulation(ErrorMessage errorMessage) {
+    private void breakSimulationAfterUpdate(PopupMessage errorMessage) {
         updateAll();
+        breakSimulation(errorMessage);
+    }
+
+    private void breakSimulation(PopupMessage errorMessage) {
         stopPressed();
         SceneFXMLController.openErrorWindow(errorMessage, canvas.getScene().getWindow());
     }

…/threebodysimulation/WarningMessage.java …ysimulation/FilenameSpecificMessage.javasrc/main/java/stl/threebodysimulation/WarningMessage.java renamed to src/main/java/stl/threebodysimulation/FilenameSpecificMessage.java src/main/java/stl/threebodysimulation/WarningMessage.java renamed to src/main/java/stl/threebodysimulation/FilenameSpecificMessage.java

@@ -1,9 +1,9 @@
 package stl.threebodysimulation;
 
 /**
- * A class that provides a template for user confirmation messages.
+ * A class that provides a template for popup messages that involve custom file names.
  */
-class WarningMessage implements PopupMessage {
+class FilenameSpecificMessage implements PopupMessage {
 
     /**
      * The title of the message.
@@ -15,28 +15,16 @@ class WarningMessage implements PopupMessage {
     private final String message;
 
     /**
-     * Constructs a new confirmation message with a filename. Should only be used for overwriting files.
+     * Constructs a new popup message with a filename.
      *
      * @param type     The type of message it is.
      * @param filepath The filepath that it points to.
      */
-    WarningMessage(Type type, String filepath) {
+    FilenameSpecificMessage(Type type, String filepath) {
         title = type.getTitle();
         message = String.format(type.getMessageTemplate(), filepath);
     }
 
-    /**
-     * Constructs a new confirmation message without a filename. Should only be used for non-filename confirmations.
-     *
-     * @param type The type of message it is.
-     */
-    @SuppressWarnings("SameParameterValue")
-    // In case other errors come up, this constructor will stay parameterized.
-    WarningMessage(Type type) {
-        title = type.getTitle();
-        message = type.getMessageTemplate();
-    }
-
     /**
      * Gets the title of the message.
      *
@@ -98,17 +86,33 @@ String getMessageTemplate() {
             }
         },
         /**
-         * For confirmations related to loading settings files.
+         * An error that occurs if a file is unable to be deleted.
+         */
+        DELETE_ERROR {
+            @Override
+            String getTitle() {
+                return "Delete File Error";
+            }
+
+            @Override
+            String getMessageTemplate() {
+                return "The following file could not be deleted:\n'%s'\nIt might be open in another window.";
+            }
+        },
+        /**
+         * An error that occurs when the user attempts to overwrite a CSV file that refuses to be edited.
          */
-        LOAD_CONFIRMATION {
+        OVERWRITE_ERROR {
+            @Override
             String getTitle() {
-                return "Load Template Confirmation";
+                return "Overwrite CSV Error";
             }
 
+            @Override
             String getMessageTemplate() {
-                return "You are about to overwrite existing settings with a saved template. Are you sure you want to proceed?";
+                return "The following file could not be edited:\n'%s'\nIt might be open in another window.";
             }
-        };
+        },;
 
         /**
          * Returns the title of the message.

…tl/threebodysimulation/ErrorMessage.java …imulation/FilenameUnspecificMessage.javasrc/main/java/stl/threebodysimulation/ErrorMessage.java renamed to src/main/java/stl/threebodysimulation/FilenameUnspecificMessage.java src/main/java/stl/threebodysimulation/ErrorMessage.java renamed to src/main/java/stl/threebodysimulation/FilenameUnspecificMessage.java

@@ -4,7 +4,7 @@
 /**
  * A class that represents error messages that can be shown in a popup.
  */
-enum ErrorMessage implements PopupMessage {
+enum FilenameUnspecificMessage implements PopupMessage {
     /**
      * An error that occurs when inputs for a simulation are incorrect.
      */
@@ -62,31 +62,15 @@ public String getMessage() {
         }
     },
     /**
-     * An error that occurs if a file is unable to be deleted.
+     * For confirmations related to loading settings files.
      */
-    DELETE_ERROR {
-        @Override
+    LOAD_CONFIRMATION {
         public String getTitle() {
-            return "Delete File Error";
+            return "Load Template Confirmation";
         }
 
-        @Override
         public String getMessage() {
-            return "The file cannot be deleted. It might be open in another window. Close all other instances of this app before trying again.";
-        }
-    },
-    /**
-     * An error that occurs when the user attempts to overwrite a CSV file that refuses to be edited.
-     */
-    OVERWRITE_ERROR {
-        @Override
-        public String getTitle() {
-            return "Overwrite CSV Error";
-        }
-
-        @Override
-        public String getMessage() {
-            return "The CSV file you specified cannot be edited. It might be open in another window. Please close all other instances of this app and try again.";
+            return "You are about to overwrite existing settings with a saved template. Are you sure you want to proceed?";
         }
     },
     /**
@@ -103,5 +87,4 @@ public String getMessage() {
             return "An unknown error occurred during the simulation. Please let the developers know, and try your simulation again.";
         }
     }
-
 }

src/main/java/stl/threebodysimulation/SavePreviewFXMLController.java

@@ -2,8 +2,6 @@
 
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
-import javafx.scene.control.Label;
-import javafx.scene.control.TitledPane;
 import javafx.scene.paint.Color;
 import org.kordamp.ikonli.material.Material;
 

src/main/java/stl/threebodysimulation/SavesPanelFXMLController.java

@@ -228,11 +228,13 @@ private void showNoSavesMessage() {
      */
     private void showDeleteConfirmation(File saveFile) {
         SceneFXMLController.openWarningWindow(
-                new WarningMessage(WarningMessage.Type.DELETE_CONFIRMATION, saveFile.getAbsolutePath()),
+                new FilenameSpecificMessage(FilenameSpecificMessage.Type.DELETE_CONFIRMATION, saveFile.getAbsolutePath()),
                 savesBox.getScene().getWindow(),
                 () -> {
                     if (!saveFile.delete()) {
-                        SceneFXMLController.openErrorWindow(ErrorMessage.DELETE_ERROR, savesBox.getScene().getWindow());
+                        SceneFXMLController.openErrorWindow(
+                                new FilenameSpecificMessage(FilenameSpecificMessage.Type.DELETE_ERROR, saveFile.getAbsolutePath()),
+                                savesBox.getScene().getWindow());
                     }
                     refreshSaves();
                 }
@@ -247,7 +249,7 @@ private void showDeleteConfirmation(File saveFile) {
     private void showLoadConfirmation(SimulationSettings settings) {
         this.settings = settings;
         SceneFXMLController.openWarningWindow(
-                new WarningMessage(WarningMessage.Type.LOAD_CONFIRMATION),
+                FilenameUnspecificMessage.LOAD_CONFIRMATION,
                 savesBox.getScene().getWindow(),
                 onLoadListener);
     }

src/main/java/stl/threebodysimulation/SceneFXMLController.java

@@ -117,7 +117,7 @@ public SceneFXMLController() {
      * @param message The error message to display.
      * @param parent  The window that the error popup must block.
      */
-    static void openErrorWindow(ErrorMessage message, Window parent) {
+    static void openErrorWindow(PopupMessage message, Window parent) {
         openPopupWindow(
                 "/stl/threebodysimulation/layouts/errorWindowLayout.fxml",
                 message,
@@ -134,7 +134,7 @@ static void openErrorWindow(ErrorMessage message, Window parent) {
      * @param parent          The window that the warning popup must block.
      * @param confirmListener The listener that will be called if the user confirms.
      */
-    static void openWarningWindow(WarningMessage message, Window parent, Listener confirmListener) {
+    static void openWarningWindow(PopupMessage message, Window parent, Listener confirmListener) {
         openPopupWindow(
                 "/stl/threebodysimulation/layouts/warningWindowLayout.fxml",
                 message,
@@ -228,7 +228,7 @@ private SettingsPanelFXMLController setupSettingsPanel() throws IOException {
 
         panelController.setup(); // Set up settings panel.
         panelController.setOnRunSimulationListener(() -> runSimulation(settingsPanelController.getSimulationSettings())); // Sets up what happens when simulation is run.
-        panelController.setOnRunErrorListener(() -> openErrorWindow(ErrorMessage.INPUT_ERROR, sceneLayout.getScene().getWindow())); // Sets up what happens when an error occurs.
+        panelController.setOnRunErrorListener(() -> openErrorWindow(FilenameUnspecificMessage.INPUT_ERROR, sceneLayout.getScene().getWindow())); // Sets up what happens when an error occurs.
         panelController.setOnSaveTemplateListener(() -> {
             savesPanelController.refreshSaves();
             tabPane.getSelectionModel().select(1);

src/main/java/stl/threebodysimulation/SettingsPanelFXMLController.java

@@ -368,7 +368,7 @@ private boolean CSVFileConflict() {
 
         // If the user presses yes, we will restart the runSimulation method from the start (with forceCSV true this time).
         SceneFXMLController.openWarningWindow(
-                new WarningMessage(WarningMessage.Type.CSV_CONFIRMATION, CSVFile.getAbsolutePath()),
+                new FilenameSpecificMessage(FilenameSpecificMessage.Type.CSV_CONFIRMATION, CSVFile.getAbsolutePath()),
                 settingsBox.getScene().getWindow(),
                 () -> {
                     forceCSV = true;
@@ -487,7 +487,7 @@ public void saveTemplate() {
         }
 
         if (!readiness) {
-            SceneFXMLController.openErrorWindow(ErrorMessage.SAVE_ERROR, settingsBox.getScene().getWindow());
+            SceneFXMLController.openErrorWindow(FilenameUnspecificMessage.SAVE_ERROR, settingsBox.getScene().getWindow());
             return;
         }
 
@@ -506,7 +506,7 @@ public void saveTemplate() {
             storeTemplate(settings, filepath);
         } else {
             SceneFXMLController.openWarningWindow(
-                    new WarningMessage(WarningMessage.Type.TEMPLATE_CONFIRMATION, saveFile.getAbsolutePath()),
+                    new FilenameSpecificMessage(FilenameSpecificMessage.Type.TEMPLATE_CONFIRMATION, saveFile.getAbsolutePath()),
                     settingsBox.getScene().getWindow(),
                     () -> {
                         forceTemplateSave = true;

src/main/resources/stl/threebodysimulation/layouts/errorWindowLayout.fxml

@@ -30,6 +30,6 @@
             </font>
         </Label>
     </HBox>
-    <Button fx:id="closeWindowButton" alignment="CENTER" mnemonicParsing="false" onAction="#closeWindow"
+    <Button alignment="CENTER" mnemonicParsing="false" onAction="#closeWindow"
             prefHeight="40.0" styleClass="primary" stylesheets="@../styles/bootstrap3.css" text="OK"/>
 </VBox>