[W5.4][F10-A3] Chen Huijia

doc/UserGuide.md

@@ -103,6 +103,11 @@ Format: `clear`
 Exits the program.<br>
 Format: `exit`  
 
+## Sorting the entries alphabetically by name : `sort`
+Sorts addressbook alphabetically <br>
+Format: `sort`
+
+
 ## Saving the data 
 Address book data are saved in the hard disk automatically after any command that changes the data.<br>
 There is no need to save manually.

src/seedu/addressbook/commands/HelpCommand.java

@@ -16,6 +16,7 @@ public class HelpCommand extends Command {
             + "\n" + ClearCommand.MESSAGE_USAGE
             + "\n" + FindCommand.MESSAGE_USAGE
             + "\n" + ListCommand.MESSAGE_USAGE
+            + "\n" + SortCommand.MESSAGE_USAGE
             + "\n" + ViewCommand.MESSAGE_USAGE
             + "\n" + ViewAllCommand.MESSAGE_USAGE
             + "\n" + HelpCommand.MESSAGE_USAGE

src/seedu/addressbook/commands/SortCommand.java

@@ -0,0 +1,21 @@
+package seedu.addressbook.commands;
+
+/*
+* sorts the addressbook
+ */
+public class SortCommand extends Command{
+    public static final String COMMAND_WORD = "sort";
+    public static final String MESSAGE_USAGE = "Sort the Addressbook alphabetically.\n"
+            + "Example: " + COMMAND_WORD;
+
+    public static final String MESSAGE_SUCCESS = "Address book has been sorted!";
+
+    public SortCommand() {}
+
+
+    @Override
+    public CommandResult execute() {
+        addressBook.sort();
+        return new CommandResult(MESSAGE_SUCCESS);
+    }
+}

src/seedu/addressbook/data/AddressBook.java

@@ -158,4 +158,12 @@ public int hashCode() {
         // use this method for custom fields hashing instead of implementing your own
         return Objects.hash(allPersons, allTags);
     }
+
+    /*
+    * sorts the list alphabetically
+     */
+    public void sort() {
+        allPersons.sort();
+
+    }
 }

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

@@ -131,4 +131,15 @@ public int hashCode() {
         return internalList.hashCode();
     }
 
+    /*
+    * sorts list alphabetically
+     */
+    public void sort() {
+        Collections.sort(internalList, new Comparator<Person>() {
+            @Override
+            public int compare(Person o1, Person o2) {
+                return o1.getName().fullName.compareTo(o2.getName().fullName);
+            }
+        });
+    }
 }

src/seedu/addressbook/parser/Parser.java

@@ -72,6 +72,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);
 

test/java/seedu/addressbook/logic/LogicTest.java

@@ -201,6 +201,25 @@ public void execute_list_showsAllPersons() throws Exception {
                               expectedList);
     }
 
+    @Test
+    public void execute_sort() throws Exception {
+        // prepare expectations
+        TestDataHelper helper = new TestDataHelper();
+        Person p1 = helper.generatePerson(4, true);
+        Person p2 = helper.generatePerson(5, true);
+        List<Person> PersonsInOrder = helper.generatePersonList(p1, p2);
+        List<Person> PersonsNotIO = helper.generatePersonList(p2, p1);
+
+        //set up the expected AB
+        AddressBook inOrderAB = new AddressBook();
+        helper.addToAddressBook(inOrderAB,PersonsInOrder);
+        helper.addToAddressBook(addressBook,PersonsNotIO);
+        AddressBook expectedAB = new AddressBook(inOrderAB.getAllPersons(), addressBook.getAllTags());
+
+        //verify results
+        assertCommandBehavior("sort", SortCommand.MESSAGE_SUCCESS,expectedAB,false,Collections.emptyList());
+    }
+
     @Test
     public void execute_view_invalidArgsFormat() throws Exception {
         String expectedMessage = String.format(MESSAGE_INVALID_COMMAND_FORMAT, ViewCommand.MESSAGE_USAGE);
@@ -587,5 +606,4 @@ Person generatePersonWithName(String name) throws Exception {
             );
         }
     }
-
 }