Refactor to match coding standard

There are minor coding standard violations

This makes it hard to standardise it to make it seem like it is written by only one person

Lets
- Make extra javadocs
- Ensure code follows the java coding standards

Author: Maurice2n97

build.gradle

@@ -27,6 +27,7 @@ dependencies {
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+    testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-params', version: '5.7.0'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'

data/duke.txt

@@ -1,5 +1,4 @@
 D | 1 | apply financial assistance | 2021-03-01
+D | 0 | CS3230 homework | 2021-03-02
 E | 0 | CS3230 midterm  | 2021-03-06
 E | 1 | graduation | I think is somewhere around 2022-05-03...
-T | 0 | CS3230 homwork
-T | 0 | NOBODY MOVE

src/main/java/duke/Duke.java

@@ -3,33 +3,40 @@
 import java.io.File;
 import java.io.IOException;
 
+import duke.command.Command;
+import duke.command.CommandResult;
+import duke.exceptions.DukeCommandParseException;
 import duke.exceptions.DukeDateParseException;
 import duke.exceptions.DukeOutOfBoundsException;
-import duke.exceptions.DukeCommandParseException;
 import duke.exceptions.DukeStorageException;
 import duke.model.TaskList;
 import duke.parser.CommandParser;
 import duke.storage.Storage;
 import duke.ui.MessageGenerator;
-import duke.command.Command;
-import duke.command.CommandResult;
+
 
 /**
  * main class containing the Duke Chatbot main logic.
  */
 
 public class Duke {
 
-    private final static String STORAGE_DIRECTORY_PATH = "data";
-    private final static String STORAGE_FILE_PATH = "data/duke.txt";
-    private final static String STORAGE_INITIALIZATION_ERROR_MESSAGE = "Cannot Crete file duke.txt";
+    private static final String STORAGE_DIRECTORY_PATH = "data";
+    private static final String STORAGE_FILE_PATH = "data/duke.txt";
+    private static final String STORAGE_INITIALIZATION_ERROR_MESSAGE = "Cannot Crete file duke.txt";
 
     private static Storage storage;
     private MessageGenerator messageGenerator;
     private TaskList tasks;
     private boolean isExit = false;
 
 
+    /**
+     * Initializes and loads all the data from storage, as well as create the nexessary classes.
+     *
+     * @throws IOException when the file does not exist and Duke cannot create the file in the necessary path
+     */
+
     public Duke() throws IOException {
         this.messageGenerator = new MessageGenerator();
         Duke.storage = initializeStorage();
@@ -62,12 +69,22 @@ private Storage initializeStorage() throws IOException {
         return new Storage("data/duke.txt");
     }
 
+    /**
+     * Returns the message to display at the start of the program.
+     *
+     * @return the message to display at the when Duke is started.
+     */
 
-
-    public String startMessage(){
+    public String startMessage() {
         return messageGenerator.getWelcomeMessage();
     }
 
+    /**
+     * Runs the Duke logic given the input string  and gets Duke's response to the input.
+     *
+     * @param input the string to be passed to Dyke
+     * @return the response after Duke analyses the string
+     */
 
     public String getResponse(String input) {
         try {
@@ -85,6 +102,13 @@ public String getResponse(String input) {
         }
     }
 
+    /**
+     * Gets the exit flag for Duke Chatbot
+     * @return the flag isExit. It is true if the exit Command has been executed.
+     * Else it will be false to show Duke is still running
+     *
+     */
+
     public boolean getIsExit() {
         return isExit;
     }

src/main/java/duke/Launcher.java

@@ -1,6 +1,5 @@
 package duke;
 
-import duke.Main;
 import javafx.application.Application;
 
 /**
@@ -10,4 +9,4 @@ public class Launcher {
     public static void main(String[] args) {
         Application.launch(Main.class, args);
     }
-}
+}

src/main/java/duke/Main.java

@@ -16,6 +16,7 @@ public class Main extends Application {
 
 
 
+
     @Override
     public void start(Stage stage) {
         try {

src/main/java/duke/command/Command.java

@@ -6,11 +6,27 @@
 import duke.storage.Storage;
 import duke.ui.MessageGenerator;
 
+/**
+ * The Command class provides the contract by which all commands must abide by.
+ * All commands should be able to be executed and return
+ * a command result. They must have access to the model and the storage,
+ * as well as a class for generating the messages to put in the
+ * CommandResult class ( if need be).
+ */
 public abstract class Command {
-    protected boolean isExitAfterExecution = false;
 
+    /**
+     * Executes a sequence of high - level instructions and returns a CommandResult data structure
+     * containing the data obtained after
+     * running the execute method.
+     *
+     * @param messageGenerator The class to handle formatting and generating UI display messages
+     * @param tasks The model of the data
+     * @param storage The class responsible to save data onto the hard disk
+     * @return CommandResult, a resulting data obtained after executing the command.
+     * @throws DukeStorageException
+     * @throws DukeOutOfBoundsException
+     */
     public abstract CommandResult execute(MessageGenerator messageGenerator, TaskList tasks, Storage storage)
             throws DukeStorageException, DukeOutOfBoundsException;
-
-
 }

src/main/java/duke/command/CommandResult.java

@@ -1,9 +1,18 @@
 package duke.command;
 
+/**
+ * A class containing the information to pass to Duke from Command class  after that Command is executed.
+ *
+ */
 public class CommandResult {
     private String messageToDisplay;
     private boolean isExit;
 
+    /**
+     * Constructor that stores the necessary information
+     * @param messageToDisplay the message for the GUI to display.
+     * @param isExit the flag indicating if the program should stop after the command is run.
+     */
     CommandResult(String messageToDisplay, boolean isExit) {
         this.messageToDisplay = messageToDisplay;
         this.isExit = isExit;

src/main/java/duke/command/DeleteCommand.java

@@ -20,7 +20,7 @@ public CommandResult execute(MessageGenerator messageGenerator, TaskList tasks,
             throws DukeStorageException, DukeOutOfBoundsException {
         Task taskToDelete = tasks.pop(indexToDelete);
         storage.saveTasks(tasks);
-        String deleteMessage = messageGenerator.generateDeleteMessage(taskToDelete,tasks);
+        String deleteMessage = messageGenerator.generateDeleteMessage(taskToDelete, tasks);
         return new CommandResult(deleteMessage, false);
     }
 }

src/main/java/duke/command/ExitCommand.java

@@ -1,14 +1,14 @@
 package duke.command;
 
-import duke.storage.Storage;
 import duke.model.TaskList;
+import duke.storage.Storage;
 import duke.ui.MessageGenerator;
 
 public class ExitCommand extends Command {
 
     @Override
     public CommandResult execute(MessageGenerator messageGenerator, TaskList tasks, Storage storage) {
         String exitMessage = messageGenerator.generateExitMessage();
-        return new CommandResult( exitMessage, true);
+        return new CommandResult(exitMessage, true);
     }
 }

src/main/java/duke/command/FindTaskCommand.java

@@ -1,7 +1,7 @@
 package duke.command;
 
-import duke.storage.Storage;
 import duke.model.TaskList;
+import duke.storage.Storage;
 import duke.ui.MessageGenerator;
 
 public class FindTaskCommand extends Command {
@@ -17,6 +17,6 @@ public FindTaskCommand(String keyword) {
     public CommandResult execute(MessageGenerator messageGenerator, TaskList tasks, Storage storage) {
         TaskList filteredTaskList = tasks.filterByWord(keyword);
         String findTaskMessage = messageGenerator.generateFindTaskMessage(filteredTaskList);
-        return new CommandResult(findTaskMessage,false);
+        return new CommandResult(findTaskMessage, false);
     }
 }