[W5][W17-1] Lee Wei Kang

docs/UserGuide.adoc

@@ -72,6 +72,11 @@ Examples:
 Shows a list of all persons, along with their non-private details, in the address book. +
 Format: `list`
 
+== Listing all persons sorted by their names : `sort`
+
+Shows a list of all persons sorted by their names, along with their non-private details, in the address book. +
+Format: `list`
+
 == Finding all persons containing any keyword in their name: `find`
 
 Finds persons whose names contain any of the given keywords. +

src/seedu/addressbook/commands/SortCommand.java

@@ -0,0 +1,23 @@
+package seedu.addressbook.commands;
+
+import seedu.addressbook.data.person.ReadOnlyPerson;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+public class SortCommand extends Command{
+    public static final String COMMAND_WORD = "sort";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD
+            + ": Displays all persons in the address book as a list with index numbers sorted by their name.\n"
+            + "Example: " + COMMAND_WORD;
+
+    @Override
+    public CommandResult execute() {
+        List<ReadOnlyPerson> allPersons = addressBook.getAllPersons().immutableListView();
+        List<ReadOnlyPerson> newList = new ArrayList<>(allPersons);
+        Collections.sort(newList);
+        return new CommandResult(getMessageForPersonListShownSummary(newList), newList);
+    }
+}

src/seedu/addressbook/data/person/Name.java

@@ -3,13 +3,14 @@
 import seedu.addressbook.data.exception.IllegalValueException;
 
 import java.util.Arrays;
+import java.util.Comparator;
 import java.util.List;
 
 /**
  * Represents a Person's name in the address book.
  * Guarantees: immutable; is valid as declared in {@link #isValidName(String)}
  */
-public class Name {
+public class Name implements Comparable<Name> {
 
     public static final String EXAMPLE = "John Doe";
     public static final String MESSAGE_NAME_CONSTRAINTS = "Person names should be spaces or alphabetic characters";
@@ -60,4 +61,8 @@ public int hashCode() {
         return fullName.hashCode();
     }
 
+    @Override
+    public int compareTo(Name o) {
+        return this.fullName.compareTo(o.fullName);
+    }
 }

src/seedu/addressbook/data/person/Person.java

@@ -88,4 +88,8 @@ public String toString() {
         return getAsTextShowAll();
     }
 
+    @Override
+    public int compareTo(ReadOnlyPerson o) {
+        return this.getName().compareTo(o.getName());
+    }
 }

src/seedu/addressbook/data/person/ReadOnlyPerson.java

@@ -1,5 +1,6 @@
 package seedu.addressbook.data.person;
 
+import java.util.Comparator;
 import java.util.Set;
 
 import seedu.addressbook.data.tag.Tag;
@@ -8,7 +9,7 @@
  * A read-only immutable interface for a Person in the addressbook.
  * Implementations should guarantee: details are present and not null, field values are validated.
  */
-public interface ReadOnlyPerson {
+public interface ReadOnlyPerson extends Comparable<ReadOnlyPerson> {
 
     Name getName();
     Phone getPhone();

src/seedu/addressbook/parser/Parser.java

@@ -11,17 +11,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import seedu.addressbook.commands.AddCommand;
-import seedu.addressbook.commands.ClearCommand;
-import seedu.addressbook.commands.Command;
-import seedu.addressbook.commands.DeleteCommand;
-import seedu.addressbook.commands.ExitCommand;
-import seedu.addressbook.commands.FindCommand;
-import seedu.addressbook.commands.HelpCommand;
-import seedu.addressbook.commands.IncorrectCommand;
-import seedu.addressbook.commands.ListCommand;
-import seedu.addressbook.commands.ViewAllCommand;
-import seedu.addressbook.commands.ViewCommand;
+import seedu.addressbook.commands.*;
 import seedu.addressbook.data.exception.IllegalValueException;
 
 /**
@@ -88,6 +78,9 @@ public Command parseCommand(String userInput) {
         case ListCommand.COMMAND_WORD:
             return new ListCommand();
 
+        case SortCommand.COMMAND_WORD:
+            return new SortCommand();
+
         case ViewCommand.COMMAND_WORD:
             return prepareView(arguments);