[Cheng Tze Ning] iP

docs/README.md

@@ -2,19 +2,29 @@
 
 ## Features 
 
-### Feature 1 
-Description of feature.
-
-## Usage
-
-### `Keyword` - Describe action
-
-Describe action and its outcome.
-
-Example of usage: 
-
-`keyword (optional arguments)`
-
-Expected outcome:
-
-`outcome`
+### Add tasks to list
+#### ToDo
+* Add a ToDo to your list of tasks in the following format: "todo {task to be done}"
+* Example: "todo read book"
+#### Deadline
+* Add a task with a deadline to your list of tasks in the following format: "deadline {task to be done} /by {date and/or time}"
+* Example: "deadline write essay /by today, 2pm"
+#### Event
+* Add an event to your list of tasks in the following format: "event {name of event} /at {date and/or time}"
+* Example: "event career fair /at 2pm, 14 Feb"
+
+### Mark a task as completed
+* Mark a task as completed in the following format: "done {index number of task in the list}"
+* Example: "done 3"
+
+### See your list of tasks
+* See your list of tasks in the following format: "list"
+* Example: "list"
+
+### Find a certain task using keywords
+* Find a certain task using keywords in the following format: "find {keywords}"
+* Example: "find book"
+
+### Delete a task from your list
+* Delete a certain task from your list in the following format: "delete {index number of the task in the list}"
+* Example: "delete 4"

src/main/java/Command.java

@@ -0,0 +1,26 @@
+/**
+<<<<<<< HEAD
+ * 
+=======
+ * A class that is the foundation where all the Commands extends from.
+>>>>>>> JavaDocs
+ */
+
+public class Command {
+    protected String command;
+    protected TextUi textUi;
+
+    public Command() {
+        this.command = "";
+    }
+
+    /**
+     * Constructor for Command object.
+     * @param command the command inputted by the user, with trailing and leading white spaces removed.
+     */
+
+    public Command(String command) {
+        this.command = command;
+        textUi = new TextUi();
+    }
+}

src/main/java/Deadline.java

@@ -0,0 +1,27 @@
+/**
+ * Extends from Task. Stores the information needed for Deadline.
+ */
+
+public class Deadline extends Task {
+
+    /**
+     * The latest date the task must be completed.
+     */
+
+    private String latestDate;
+
+    /**
+     * Constructor for Deadline.
+     * @param userInput the command that the user typed in.
+     */
+
+    public Deadline(String userInput) {
+        super(userInput.substring(0, userInput.indexOf(" /")));
+        this.latestDate = userInput.substring(userInput.indexOf("/") + 4);
+    }
+
+    @Override
+    public String toString() {
+        return String.format("[D][%c] %s (by: %s)", isDone() ? '✓' : '✗', taskName, latestDate);
+    }
+}

src/main/java/DeadlineCommand.java

@@ -0,0 +1,24 @@
+/**
+ * Extends from Command. Gives instructions on how to proceed when a Deadline task is added.
+ */
+
+public class DeadlineCommand extends Command {
+
+    /**
+     * Create a new Deadline task as requested by the user.
+     */
+
+    private Deadline deadline;
+
+    /**
+     * Constructor for DeadlineCommand.
+     * @param command the command that the user typed in.
+     * @throws IndexOutOfBoundsException throws IndexOutOfBoundsException when there are invalid arguments.
+     */
+    public DeadlineCommand(String command) throws IndexOutOfBoundsException {
+        super(command);
+        deadline = new Deadline(command.substring(9));
+        Duke.tasks.add(deadline);
+        textUi.printDeadlineMessage(deadline);
+    }
+}

src/main/java/DeleteCommand.java

@@ -0,0 +1,19 @@
+/**
+ * Extends from Command. Gives instructions on how to proceed when a task needs to be deleted.
+ */
+
+public class DeleteCommand extends Command {
+
+    /**
+     * Constructor for DeleteCommand.
+     * @param command the command that the user typed in.
+     * @throws IndexOutOfBoundsException throw IndexOutOfBoundsException when there are invalid arguments.
+     */
+    public DeleteCommand(String command) throws IndexOutOfBoundsException {
+        super(command);
+        int selectedTaskId = Integer.parseInt(command.substring(7));
+        Task task = Duke.tasks.get(selectedTaskId - 1);
+        Duke.tasks.remove(task);
+        textUi.printDeleteMessage(task, Duke.tasks.size());
+    }
+}

src/main/java/DoneCommand.java

@@ -0,0 +1,15 @@
+/**
+ * Extends from Command. Gives instructions on how to proceed when a task is completed.
+ */
+
+public class DoneCommand extends Command {
+
+    /**
+     * Constructor for DoneCommand.
+     * @param command the command that the user typed in.
+     */
+    public DoneCommand(String command) {
+        super(command);
+        Duke.tasks.get(Integer.parseInt(command.substring(5)) - 1).setDone();
+    }
+}

src/main/java/Duke.java

@@ -1,10 +1,45 @@
+import java.io.FileNotFoundException;
+import java.io.PrintWriter;
+import java.util.Scanner;
+import java.util.ArrayList;
+
+/**
+<<<<<<< HEAD
+ * Duke is a project that keeps a list of the tasks that need to be completed.
+=======
+ * Project Duke.
+ * Keeps a record of the tasks that the user has, which can be saved into and loaded from a hard disk.
+>>>>>>> JavaDocs
+ */
+
 public class Duke {
+    static ArrayList<Task> tasks = new ArrayList<>();
+
+    /**
+     * Stores any methods that require interaction with the user.
+     */
+
+    static TextUi textUi = new TextUi();
+
+    /**
+     * Contains all the necessary objects to keep track of the tasks.
+     * @param args
+     */
+
     public static void main(String[] args) {
-        String logo = " ____        _        \n"
-                + "|  _ \\ _   _| | _____ \n"
-                + "| | | | | | | |/ / _ \\\n"
-                + "| |_| | |_| |   <  __/\n"
-                + "|____/ \\__,_|_|\\_\\___|\n";
-        System.out.println("Hello from\n" + logo);
+        textUi.printWelcomeMessage();
+        Scanner scan = new Scanner(System.in);
+        String userInput = scan.nextLine();
+        while (!userInput.equals("bye")) {
+            try {
+                Parser.parseInput(userInput);
+            } catch (IndexOutOfBoundsException exception) {
+                textUi.printIndexOutOfBoundsExceptionMessage(exception);
+            } catch (IllegalArgumentException exception) {
+                textUi.printIllegalArgumentExceptionMessage(exception);
+            }
+            userInput = scan.nextLine();
+        }
+        textUi.printExitMessage();
     }
 }

src/main/java/Event.java

@@ -0,0 +1,26 @@
+/**
+ * Extends from Task. Stores the information needed for Event.
+ */
+
+public class Event extends Task {
+
+    /**
+     * The details of the event as stated by the user.
+     */
+
+    private String eventDetails;
+
+    /**
+     * Constructor for Event.
+     * @param userInput the command that the user typed in.
+     */
+    public Event(String userInput) {
+        super(userInput.substring(0, userInput.indexOf(" /")));
+        this.eventDetails = userInput.substring(userInput.indexOf("/") + 4);
+    }
+
+    @Override
+    public String toString() {
+        return String.format("[E][%c] %s (at: %s)", isDone() ? '✓' : '✗', taskName, eventDetails);
+    }
+}

src/main/java/EventCommand.java

@@ -0,0 +1,24 @@
+/**
+ * Extends from Command. Gives instructions on how to proceed when an Event task is added.
+ */
+
+public class EventCommand extends Command {
+
+    /**
+     * Creates a new Event task as requested by the user.
+     */
+    private Event event;
+
+    /**
+     * Constructor for EventCommand.
+     * @param command the command that the user typed in.
+     * @throws IndexOutOfBoundsException throws IndexOutOfBoundsException when there are invalid arguments.
+     */
+
+    public EventCommand(String command) throws IndexOutOfBoundsException {
+        super(command);
+        event = new Event(command.substring(6));
+        Duke.tasks.add(event);
+        textUi.printEventMessage(event);
+    }
+}

src/main/java/FindCommand.java

@@ -0,0 +1,22 @@
+public class FindCommand extends Command {
+    public FindCommand(String command) {
+        super(command);
+        execute(command);
+    }
+
+    public void execute(String command) {
+        textUi.printFindMessage(command);
+        String keyword = command.substring(5);
+        boolean isFound = false;
+        for (Task task : Duke.tasks) {
+            if (task.getTaskName().contains(keyword)) {
+                System.out.println(task.getTaskId() + ". " + task.toString());
+                isFound = true;
+            }
+        }
+        if (!isFound) {
+            System.out.println("Sorry there are no matches");
+        }
+
+    }
+}

src/main/java/ListCommand.java

@@ -0,0 +1,27 @@
+/**
+ * Extends from Command. Gives instructions on how to proceed when a list of the tasks is requested.
+ */
+
+public class ListCommand extends Command {
+
+    /**
+     * Stores the list of tasks in a text file on the hard disk.
+     */
+
+    private Storage storage;
+
+    /**
+     * Constructor for ListCommand.
+     * @param command the command that the user typed in.
+     */
+
+    public ListCommand(String command) {
+        super(command);
+        storage = new Storage();
+        for (Task task : Duke.tasks) {
+            System.out.println(String.format("%d. %s", task.getTaskId(), task.toString()));
+            storage.addToList(String.format("%d. %s", task.getTaskId(), task.toString()));
+        }
+        storage.storeList();
+    }
+}

src/main/java/Messages.java

@@ -0,0 +1,37 @@
+/**
+ * Contains all the frequently used messages displayed to the user.
+ */
+
+public class Messages {
+
+    /**
+     * List of commands that the user can input.
+     */
+    public static String LIST_OF_COMMANDS = "Here is the list of commands available\n"
+            + "\"bye\": to exit\n" +
+            "\"list\": to show the list of all your tasks\n" +
+            "\"todo\": add a todo\n" +
+            "\"deadline\": add a deadline\n" +
+            "\"event\": add an event\n" +
+            "\"done\": check off a task on your list\n";
+
+    /**
+     * Exit message.
+     */
+
+    public static String EXIT_MESSAGE = "Bye la you";
+
+    /**
+     * Duke logo.
+     */
+    public static String LOGO = " ____        _        \n" +
+            "|  _ \\\\ _   _| | __ __ \n" +
+            "| | | | | | | |/ / _ \\\n" +
+            "| |_| | |_| |   <  __/\n" +
+            "|____/ \\\\__,_|_|\\_\\\\___\n";
+
+    /**
+     * Welcome message when the user first enters.
+     */
+    public static String WELCOME_MESSAGE = "Hello there I am\n" + LOGO + LIST_OF_COMMANDS;
+}

src/main/java/NoSuchCommand.java

@@ -0,0 +1,17 @@
+/**
+ * Extends from Command. Gives instructions on how to proceed when the command is not recognised.
+ */
+
+public class NoSuchCommand extends Command {
+
+    /**
+     * Constructor for NoSuchCommand.
+     * @param command the command that the user typed in.
+     * @throws IllegalArgumentException throws IllegalArgumentException within the constructor for the main method
+     * to catch.
+     */
+    public NoSuchCommand(String command) throws IllegalArgumentException{
+        super(command);
+        throw new IllegalArgumentException();
+    }
+}