[W5.7][F10-2]Lim Fong Yuan

src/seedu/addressbook/commands/AddCommand.java

@@ -20,11 +20,10 @@ public class AddCommand extends Command {
 
     public static final String COMMAND_WORD = "add";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
-            + "Contact details can be marked private by prepending 'p' to the prefix.\n"
-            + "Parameters: NAME [p]p/PHONE [p]e/EMAIL [p]a/ADDRESS  [t/TAG]...\n"
-            + "Example: " + COMMAND_WORD
-            + " John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 t/friends t/owesMoney";
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Adds a person to the address book. Contact details can be marked private by prepending 'p' to the prefix.",
+        "NAME [p]p/PHONE [p]e/EMAIL [p]a/ADDRESS  [t/TAG]...",
+        "John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 t/friends t/owesMoney");
 
     public static final String MESSAGE_SUCCESS = "New person added: %1$s";
     public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book";

src/seedu/addressbook/commands/ClearCommand.java

@@ -6,8 +6,8 @@
 public class ClearCommand extends Command {
 
     public static final String COMMAND_WORD = "clear";
-    public static final String MESSAGE_USAGE = "Clears address book permanently.\n"
-            + "Example: " + COMMAND_WORD;
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Clears address book permanently.");
 
     public static final String MESSAGE_SUCCESS = "Address book has been cleared!";
 

src/seedu/addressbook/commands/Command.java

@@ -26,6 +26,38 @@ public Command(int targetIndex) {
     protected Command() {
     }
 
+    /**
+     * Generates the MESSAGE_USAGE for a command.
+     * @param commandWord The command's COMMAND_WORD
+     * @param commandDesc A brief description of what the command does
+     * @param commandParams The list of parameters the command accepts, or "none" if the command has no parameters
+     * @param commandEgParams An example of a set of valid parameter values to pass to the command, give "" if the command has no parameters
+     * @return the MESSAGE_USAGE for a command.
+     */
+    protected static String getMessageUsage(
+        String commandWord,
+        String commandDesc,
+        String commandParams,
+        String commandEgParams) {
+
+        return commandWord + ": " + commandDesc + "\n"
+            + "    Parameters: " + commandParams + "\n"
+            + "    Example: " + commandWord + (commandEgParams.equals("") ? "" : " " + commandEgParams);
+    }
+
+    /**
+     * Overloaded getMessageUsage() for commands that take in no parameters
+     * @param commandWord The command's COMMAND_WORD
+     * @param commandDesc A brief description of what the command does
+     * @return the MESSAGE_USAGE for a command.
+     */
+    protected static String getMessageUsage(
+        String commandWord,
+        String commandDesc) {
+
+        return getMessageUsage(commandWord, commandDesc, "none", "");
+    }
+
     /**
      * Constructs a feedback message to summarise an operation that displayed a listing of persons.
      *

src/seedu/addressbook/commands/DeleteCommand.java

@@ -12,10 +12,10 @@ public class DeleteCommand extends Command {
 
     public static final String COMMAND_WORD = "delete";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD
-            + ": Deletes the person identified by the index number used in the last person listing.\n"
-            + "Parameters: INDEX\n"
-            + "Example: " + COMMAND_WORD + " 1";
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Deletes the person identified by the index number used in the last person listing.",
+        "INDEX",
+        "1");
 
     public static final String MESSAGE_DELETE_PERSON_SUCCESS = "Deleted Person: %1$s";
 

src/seedu/addressbook/commands/ExitCommand.java

@@ -7,8 +7,9 @@ public class ExitCommand extends Command {
 
     public static final String COMMAND_WORD = "exit";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Exits the program.\n"
-            + "Example: " + COMMAND_WORD;
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Exits the program.");
+
     public static final String MESSAGE_EXIT_ACKNOWEDGEMENT = "Exiting Address Book as requested ...";
 
     @Override

src/seedu/addressbook/commands/FindCommand.java

@@ -16,10 +16,10 @@ public class FindCommand extends Command {
 
     public static final String COMMAND_WORD = "find";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names contain any of "
-            + "the specified keywords (case-sensitive) and displays them as a list with index numbers.\n"
-            + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
-            + "Example: " + COMMAND_WORD + " alice bob charlie";
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Finds all persons whose names contain any of the specified keywords (case-sensitive) and displays them as a list with index numbers.",
+        "KEYWORD [MORE_KEYWORDS]...",
+        "alice bob charlie");
 
     private final Set<String> keywords;
 

src/seedu/addressbook/commands/HelpCommand.java

@@ -8,8 +8,8 @@ public class HelpCommand extends Command {
 
     public static final String COMMAND_WORD = "help";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Shows program usage instructions.\n"
-            + "Example: " + COMMAND_WORD;
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Shows program usage instructions.");
 
     @Override
     public CommandResult execute() {

src/seedu/addressbook/commands/ListCommand.java

@@ -12,9 +12,8 @@ public class ListCommand extends Command {
 
     public static final String COMMAND_WORD = "list";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD
-            + ": Displays all persons in the address book as a list with index numbers.\n"
-            + "Example: " + COMMAND_WORD;
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Displays all persons in the address book as a list with index numbers.");
 
 
     @Override

src/seedu/addressbook/commands/ViewAllCommand.java

@@ -12,10 +12,10 @@ public class ViewAllCommand extends Command {
 
     public static final String COMMAND_WORD = "viewall";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Views the non-private details of the person "
-            + "identified by the index number in the last shown person listing.\n"
-            + "Parameters: INDEX\n"
-            + "Example: " + COMMAND_WORD + " 1";
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Views the non-private details of the person identified by the index number in the last shown person listing.",
+        "INDEX",
+        "1");
 
     public static final String MESSAGE_VIEW_PERSON_DETAILS = "Viewing person: %1$s";
 

src/seedu/addressbook/commands/ViewCommand.java

@@ -12,10 +12,10 @@ public class ViewCommand extends Command {
 
     public static final String COMMAND_WORD = "view";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Views the non-private details of the person "
-            + "identified by the index number in the last shown person listing.\n"
-            + "Parameters: INDEX\n"
-            + "Example: " + COMMAND_WORD + " 1";
+    public static final String MESSAGE_USAGE = Command.getMessageUsage(COMMAND_WORD,
+        "Views the non-private details of the person identified by the index number in the last shown person listing.",
+        "INDEX",
+        "1");
 
     public static final String MESSAGE_VIEW_PERSON_DETAILS = "Viewing person: %1$s";