Merge pull request #4 from YingxuH/branch-A-CodeQuality

Branch a code quality

Author: YingxuH

src/main/java/Duke.java

@@ -1,15 +1,17 @@
 //package java;
 
-import exceptions.IllegalDateTimeFormatException;
 import parser.Command;
 import parser.ExitCommand;
 import parser.Parser;
+
+import exceptions.IllegalDateTimeFormatException;
 import exceptions.InvalidStorageFilePathException;
 import exceptions.NoCommandException;
 import exceptions.StorageOperationException;
+import exceptions.NoDescriptionException;
+
 import model.TaskList;
 
-import exceptions.NoDescriptionException;
 import storage.Storage;
 
 import java.io.IOException;
@@ -27,7 +29,7 @@ public class Duke {
     protected Ui ui;
 
     public Duke() {
-        this.userName = "";
+
     }
 
     /**
@@ -39,11 +41,11 @@ public Duke(String userName) {
     }
 
     private void start() {
-        this.ui = new Ui();
+        ui = new Ui();
         try {
-            this.parser = new Parser();
-            this.storage = new Storage();
-            this.taskList = storage.load();
+            parser = new Parser();
+            storage = new Storage();
+            taskList = storage.load();
             ui.askForName();
             ui.greet();
         } catch (InvalidStorageFilePathException | IOException e) {
@@ -55,26 +57,17 @@ private void start() {
     }
 
     /**
-     * exit with status 0.
+     * Listen to the user input and take actions.
      */
-    private void exit() {
-        System.exit(0);
-    }
-
-    /**
-     * Listen to the user input and start interactions.
-     */
-    private void run() {
+    private void listen() {
         Command command = new Command();
-        this.start();
 
         while (!ExitCommand.isExit(command)) {
             try {
                 String input = ui.getUserInput();
                 command = parser.parseCommand(input);
-                command.setTaskList(this.taskList);
-                String commandResult = command.execute();
-                ui.printCommandResult(commandResult);
+                command.setTaskList(taskList);
+                ui.printCommandResult(command.execute());
                 storage.save(taskList);
             } catch (NoDescriptionException | NoCommandException | IllegalDateTimeFormatException e) {
                 ui.printErrorMessage(e.getMessage());
@@ -83,7 +76,19 @@ private void run() {
                 throw new RuntimeException(e);
             }
         }
-        this.exit();
+    }
+
+    /**
+     * exit with status 0.
+     */
+    private void exit() {
+        System.exit(0);
+    }
+
+    private void run() {
+        start();
+        listen();
+        exit();
     }
 
     public static void main(String[] args) {

src/main/java/exceptions/NoTimeException.java

@@ -9,8 +9,9 @@
  * Presents the deadline task in the task list.
  */
 public class DeadLineTask extends Task {
+    public static final String TASK_TYPE_CHA = "D";
+
     private static final String TASK_TYPE_STRING = "deadline task";
-    private static final String TASK_TYPE_CHA = "D";
 
     private LocalDateTime by;
 
@@ -29,6 +30,18 @@ public DeadLineTask(String description, LocalDateTime by) throws NoDescriptionEx
         this.by = by;
     }
 
+    /**
+     * Constructs an {@code DeadLineTask}.
+     * @param description a not empty description.
+     * @param by a valid date time object.
+     * @param isDone A boolean indicating whether the task is done.
+     * @throws NoDescriptionException if the description is empty.
+     */
+    public DeadLineTask(String description, LocalDateTime by, boolean isDone) throws NoDescriptionException {
+        super(description, TASK_TYPE_STRING, isDone);
+        this.by = by;
+    }
+
     /**
      * get and return the single-character task type. E.g. "E", "T", or "D".
      * @return TASK_TYPE_CHA single-character task type.

src/main/java/model/DeadLineTask.java

@@ -11,8 +11,9 @@
  * Represents an event task in the inner-task list.
  */
 public class EventTask extends Task {
+    public static final String TASK_TYPE_CHA = "E";
+
     private static final String TASK_TYPE_STRING = "event task";
-    private static final String TASK_TYPE_CHA = "E";
 
     private LocalDateTime at;
 
@@ -31,6 +32,18 @@ public EventTask(String description, LocalDateTime at) throws NoDescriptionExcep
         this.at = at;
     }
 
+    /**
+     * Constructs an {@code EventTask} with description, dateTime, and isDone status.
+     * @param description A not empty description.
+     * @param at A valid datetime object.
+     * @param isDone A boolean indicating whether the task is done.
+     * @throws NoDescriptionException if the description is empty.
+     */
+    public EventTask(String description, LocalDateTime at, boolean isDone) throws NoDescriptionException {
+        super(description, TASK_TYPE_STRING, isDone);
+        this.at = at;
+    }
+
     /**
      * get and return the single-character task type. E.g. "E", "T", or "D".
      * @return TASK_TYPE_CHA single-character task type.

src/main/java/model/EventTask.java

@@ -2,6 +2,7 @@
 
 import exceptions.NoDescriptionException;
 
+import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.time.format.DateTimeFormatter;
@@ -12,12 +13,14 @@
  */
 public abstract class Task {
     protected String description;
-    private String taskTypeString;
     protected boolean isDone;
+    private String taskTypeString;
 
-    private static final String DEFAULT_TASK_TYPE_STRING = "task";
     static final DateTimeFormatter DATE_TIME_FORMAT = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm");
 
+    private static final String DEFAULT_TASK_TYPE_STRING = "task";
+    private static final boolean DEFAULT_TASK_IS_DONE = false;
+
     public Task() {
 
     }
@@ -28,14 +31,7 @@ public Task() {
      * @throws NoDescriptionException If the description is empty.
      */
     public Task(String description) throws NoDescriptionException {
-        this.taskTypeString = DEFAULT_TASK_TYPE_STRING;
-        if ("".equals(description)) {
-            throw new NoDescriptionException("OOPS!!! The description of a "
-                    + taskTypeString
-                    + " cannot be empty.\n");
-        }
-        this.description = description;
-        this.isDone = false;
+        this(description, DEFAULT_TASK_TYPE_STRING, DEFAULT_TASK_IS_DONE);
     }
 
     /**
@@ -45,14 +41,25 @@ public Task(String description) throws NoDescriptionException {
      * @throws NoDescriptionException If the description is empty.
      */
     public Task(String description, String taskTypeString) throws NoDescriptionException {
+        this(description, taskTypeString, DEFAULT_TASK_IS_DONE);
+    }
+
+    /**
+     * Constructs a {@code Task} with the input description, task type string, and task status.
+     * @param description A not empty description.
+     * @param taskTypeString A not empty task type string.
+     * @param taskIsDone A boolean object indicating whether the task is done.
+     * @throws NoDescriptionException If the description is empty.
+     */
+    public Task(String description, String taskTypeString, boolean taskIsDone) throws NoDescriptionException {
         this.taskTypeString = taskTypeString;
         if ("".equals(description)) {
             throw new NoDescriptionException("OOPS!!! The description of a "
                     + this.taskTypeString
                     + " cannot be empty.\n");
         }
         this.description = description;
-        this.isDone = false;
+        this.isDone = taskIsDone;
     }
 
     /**

src/main/java/model/Task.java

@@ -16,7 +16,7 @@ public class TaskList implements Iterable<Task> {
     private static final String ECHO_DELETE_TASK = "Noted. I have removed this task:\n";
     private static final String ECHO_VIEW_TASK_LIST = "Here are the tasks in your list:\n";
     private static final String ECHO_COMPLETE_TASK = "Nice! I've marked this task as done:\n";
-    private final String ECHO_FIND_TASK = "Here are the matching tasks in your list:\n";
+    private static final String ECHO_FIND_TASK = "Here are the matching tasks in your list:\n";
 
     public TaskList() {
 
@@ -113,18 +113,17 @@ public String findByKeyWord(String keyWord) {
      * @return string representation of the task list.
      */
     public String toString() {
-        String listOverView = ECHO_VIEW_TASK_LIST;
+        StringBuilder listOverView = new StringBuilder(ECHO_VIEW_TASK_LIST);
         for (int i = 0; i < this.internalList.size(); i++) {
             if (this.internalList.get(i) == null) {
                 continue;
             }
-            listOverView = listOverView
-                    + Integer.toString(i + 1)
-                    + "."
-                    + this.internalList.get(i).toString()
-                    + "\n";
+            listOverView.append(Integer.toString(i + 1));
+            listOverView.append(".");
+            listOverView.append(this.internalList.get(i).toString());
+            listOverView.append("\n");
         }
-        return listOverView;
+        return listOverView.toString();
     }
 
     /**

src/main/java/model/TaskList.java

@@ -6,8 +6,9 @@
  * Represents an todo task in the inner-task list.
  */
 public class ToDoTask extends Task {
+    public static final String TASK_TYPE_CHA = "T";
+
     private static final String TASK_TYPE_STRING = "todo task";
-    private static final String TASK_TYPE_CHA = "T";
 
     public ToDoTask() {
 
@@ -22,6 +23,16 @@ public ToDoTask(String description) throws NoDescriptionException {
         super(description, TASK_TYPE_STRING);
     }
 
+    /**
+     * Constructs an {@code ToDoTask} with input description and isDone status.
+     * @param description A not empty description.
+     * @param isDone A boolean indicating whether the task is done.
+     * @throws NoDescriptionException if the description is empty.
+     */
+    public ToDoTask(String description, boolean isDone) throws NoDescriptionException {
+        super(description, TASK_TYPE_STRING, isDone);
+    }
+
     /**
      * Convert the details of the task, such as description, deadline to one arraylist
      * for encoder to encode in a string.

src/main/java/model/ToDoTask.java

@@ -6,18 +6,20 @@
 /**
  * Abstract class implementing part of the command object.
  */
-public class Command {
+public abstract class Command {
     protected TaskList taskList;
 
     public Command() {
 
     }
 
-    public void setTaskList(TaskList taskList) {
+    public Command(TaskList taskList) {
         this.taskList = taskList;
     }
 
-    public String execute() throws NoDescriptionException {
-        return "";
+    public void setTaskList(TaskList taskList) {
+        this.taskList = taskList;
     }
+
+    public abstract String execute() throws NoDescriptionException;
 }