[T4A3][T15-A1] Neo Wei Jie, Esmond

.gitignore

@@ -1,6 +1,6 @@
 # Default storage file for addressbook : don't need to cleanup when running from IDE
 
-addressbook.txt
+addressbook.xml
 
 # Compiled classfiles
 bin/

README.md

@@ -1,3 +1,5 @@
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ad7aa7caa7ba4d40aef9440b16ea68d6)](https://www.codacy.com/app/se-edu/addressbook-level2?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level2&utm_campaign=Badge_Grade)
+
 # AddressBook (Level 2)
 * This is a CLI (Command Line Interface) Address Book application **written in OOP fashion**. 
 * It is a Java sample application intended for students learning Software Engineering while using Java as 
@@ -19,4 +21,4 @@
 
 * **Bug reports, Suggestions** : Post in our [issue tracker](https://github.com/se-edu/addressbook-level2/issues)
   if you noticed bugs or have suggestions on how to improve.
-* **Contributing** : We welcome pull requests. Follow the process described [here](https://github.com/oss-generic/process)
+* **Contributing** : We welcome pull requests. Follow the process described [here](https://github.com/oss-generic/process)

doc/UserGuide.md

@@ -123,13 +123,13 @@ Address book data are saved in the hard disk automatically after any command tha
 There is no need to save manually.
 
 #### Changing the save location
-Address book data are saved in a file called `addressbook.txt` in the project root folder.
+Address book data are saved in a file called `addressbook.xml` in the project root folder.
 You can change the location by specifying the file path as a program argument.
 
 Example: 
-* `java seedu.addressbook.Main mydata.txt`
+* `java seedu.addressbook.Main mydata.xml`
 
-> The file name must end in `.txt` for it to be acceptable to the program.
+> The file name must end in `.xml` for it to be acceptable to the program.
 >
 > When running the program inside Eclipse, you can set command line parameters 
   before running the program.

src/seedu/addressbook/Main.java

@@ -99,7 +99,7 @@ private void recordResult(CommandResult result) {
 
     /**
      * Executes the command and returns the result.
-     * 
+     *
      * @param command user command
      * @return result of the command
      */
@@ -126,4 +126,4 @@ private StorageFile initializeStorage(String[] launchArgs) throws InvalidStorage
     }
 
 
-}
+}

src/seedu/addressbook/commands/AddCommand.java

@@ -17,9 +17,9 @@ public class AddCommand extends Command {
 
     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"
+            + "Parameters: NAME [p]p/PHONE [p]e/EMAIL [p]a/BLOCK, STREET, UNIT, POSTAL CODE  [t/TAG]...\n"
             + "Example: " + COMMAND_WORD
-            + " John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 t/friends t/owesMoney";
+            + " John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25, 622311 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

@@ -1,8 +1,5 @@
 package seedu.addressbook.commands;
 
-import seedu.addressbook.common.Utils;
-
-
 /**
  * Clears the address book.
  */

src/seedu/addressbook/commands/Command.java

@@ -32,7 +32,7 @@ protected Command() {
      * @param personsDisplayed used to generate summary
      * @return summary message for persons displayed
      */
-    protected String getMessageForPersonListShownSummary(List<? extends ReadOnlyPerson> personsDisplayed) {
+    public static String getMessageForPersonListShownSummary(List<? extends ReadOnlyPerson> personsDisplayed) {
         return String.format(Messages.MESSAGE_PERSONS_LISTED_OVERVIEW, personsDisplayed.size());
     }
 

src/seedu/addressbook/commands/CommandResult.java

@@ -11,8 +11,12 @@
 public class CommandResult {
 
     /** The feedback message to be shown to the user. Contains a description of the execution result */
-    public final String feedbackToUser;
-
+    private final String feedbackToUser;
+
+    public String getFeedbackToUser(){
+        return feedbackToUser;
+    }
+
     /** The list of persons that was produced by the command */
     private final List<? extends ReadOnlyPerson> relevantPersons;
 

src/seedu/addressbook/commands/FindCommand.java

@@ -1,8 +1,12 @@
 package seedu.addressbook.commands;
 
-import seedu.addressbook.data.person.ReadOnlyPerson;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 
-import java.util.*;
+import seedu.addressbook.data.person.ReadOnlyPerson;
 
 /**
  * Finds and lists all persons in address book whose name contains any of the argument keywords.

src/seedu/addressbook/commands/IncorrectCommand.java

@@ -4,11 +4,11 @@
 /**
  * Represents an incorrect command. Upon execution, produces some feedback to the user.
  */
-public class IncorrectCommand extends Command{
+public class IncorrectCommand extends Command {
 
     public final String feedbackToUser;
 
-    public IncorrectCommand(String feedbackToUser){
+    public IncorrectCommand(String feedbackToUser) {
         this.feedbackToUser = feedbackToUser;
     }
 

src/seedu/addressbook/common/Utils.java

@@ -2,7 +2,6 @@
 
 import java.util.Collection;
 import java.util.HashSet;
-import java.util.Objects;
 import java.util.Set;
 
 /**

src/seedu/addressbook/data/AddressBook.java

@@ -143,4 +143,12 @@ public UniquePersonList getAllPersons() {
     public UniqueTagList getAllTags() {
         return new UniqueTagList(allTags);
     }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof AddressBook // instanceof handles nulls
+                        && this.allPersons.equals(((AddressBook) other).allPersons)
+                        && this.allTags.equals(((AddressBook) other).allTags));
+    }
 }

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

@@ -6,38 +6,61 @@
  * Represents a Person's address in the address book.
  * Guarantees: immutable; is valid as declared in {@link #isValidAddress(String)}
  */
-public class Address {
+public class Address extends Contact {
 
     public static final String EXAMPLE = "123, some street";
     public static final String MESSAGE_ADDRESS_CONSTRAINTS = "Person addresses can be in any format";
     public static final String ADDRESS_VALIDATION_REGEX = ".+";
-
-    public final String value;
-    private boolean isPrivate;
-
-    /**
+
+    public static final int ADDRESS_INDEX_BLOCK = 0;
+    public static final int ADDRESS_INDEX_STREET = 1;
+    public static final int ADDRESS_INDEX_UNIT = 2;
+    public static final int ADDRESS_INDEX_POSTAL_CODE = 3;
+    public static final int ADDRESS_FIELD_COUNT = 4;
+
+    private Block addressBlock;
+    private Street addressStreet;
+    private Unit addressUnit;
+    private PostalCode addressPostalCode;
+
+    /*
      * Validates given address.
-     *
      * @throws IllegalValueException if given address string is invalid.
      */
     public Address(String address, boolean isPrivate) throws IllegalValueException {
-        this.isPrivate = isPrivate;
-        if (!isValidAddress(address)) {
+        /*
+         * Address Format: a/ BLOCK, STREET, FLOOR-UNIT, POSTAL_CODE
+         */
+        super(address,isPrivate);
+        if (!isValidAddress(value)) {
             throw new IllegalValueException(MESSAGE_ADDRESS_CONSTRAINTS);
         }
-        this.value = address;
+        String[] addressField = splitAddress(value);
+        fillAddressField(addressField);
+    }
+
+    public String[] splitAddress(String address){
+        return address.split(",");
+    }
+
+    public void fillAddressField(String[] addressField){
+        addressBlock = new Block(addressField[ADDRESS_INDEX_BLOCK].trim());
+        addressStreet = new Street(addressField[ADDRESS_INDEX_STREET].trim());
+        addressUnit = new Unit(addressField[ADDRESS_INDEX_UNIT].trim());
+        addressPostalCode = new PostalCode(addressField[ADDRESS_INDEX_POSTAL_CODE].trim());
     }
 
     /**
      * Returns true if a given string is a valid person email.
      */
     public static boolean isValidAddress(String test) {
-        return test.matches(ADDRESS_VALIDATION_REGEX);
+        return test.matches("(.*),(.*),(.*)-(.*),(.*)");
     }
 
     @Override
     public String toString() {
-        return value;
+        return addressBlock.getBlockNumber()+", "+addressStreet.getStreetName()+", "
+                +addressUnit.getUnitNumber()+", "+addressPostalCode.getPostalCode();
     }
 
     @Override
@@ -46,13 +69,4 @@ public boolean equals(Object other) {
                 || (other instanceof Address // instanceof handles nulls
                 && this.value.equals(((Address) other).value)); // state check
     }
-
-    @Override
-    public int hashCode() {
-        return value.hashCode();
-    }
-
-    public boolean isPrivate() {
-        return isPrivate;
-    }
-}
+}

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

@@ -0,0 +1,17 @@
+package seedu.addressbook.data.person;
+
+public class Block {
+    private int blockNumber;
+
+    public Block(String blockNumber){
+        setBlockNumber(blockNumber);
+    }
+
+    public int getBlockNumber(){
+        return blockNumber;
+    }
+
+    public void setBlockNumber(String blockNumber){
+        this.blockNumber = Integer.parseInt(blockNumber);
+    }
+}

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

@@ -0,0 +1,34 @@
+package seedu.addressbook.data.person;
+
+import seedu.addressbook.data.exception.IllegalValueException;
+
+/**
+ * The parent class for Email, Address and phone.
+ */
+public class Contact {
+    public final String value;
+    protected boolean isPrivate;
+
+    public Contact(String contact, boolean isPrivate) throws IllegalValueException {
+        this.isPrivate = isPrivate;
+        String trimmedContact = contact.trim();
+        this.value = trimmedContact;
+    }
+
+    @Override
+    public String toString() {
+        return value;
+    }
+
+
+    @Override
+    public int hashCode() {
+        return value.hashCode();
+    }
+
+
+    public boolean isPrivate() {
+        return isPrivate;
+    }
+
+}

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

@@ -6,28 +6,23 @@
  * Represents a Person's email in the address book.
  * Guarantees: immutable; is valid as declared in {@link #isValidEmail(String)}
  */
-public class Email {
+public class Email extends Contact {
 
     public static final String EXAMPLE = "[email protected]";
     public static final String MESSAGE_EMAIL_CONSTRAINTS =
             "Person emails should be 2 alphanumeric/period strings separated by '@'";
     public static final String EMAIL_VALIDATION_REGEX = "[\\w\\.]+@[\\w\\.]+";
 
-    public final String value;
-    private boolean isPrivate;
-
     /**
      * Validates given email.
      *
      * @throws IllegalValueException if given email address string is invalid.
      */
     public Email(String email, boolean isPrivate) throws IllegalValueException {
-        this.isPrivate = isPrivate;
-        email = email.trim();
-        if (!isValidEmail(email)) {
+        super(email,isPrivate);
+        if (!isValidEmail(value)) {
             throw new IllegalValueException(MESSAGE_EMAIL_CONSTRAINTS);
         }
-        this.value = email;
     }
 
     /**
@@ -37,25 +32,10 @@ public static boolean isValidEmail(String test) {
         return test.matches(EMAIL_VALIDATION_REGEX);
     }
 
-    @Override
-    public String toString() {
-        return value;
-    }
-
     @Override
     public boolean equals(Object other) {
         return other == this // short circuit if same object
                 || (other instanceof Email // instanceof handles nulls
                 && this.value.equals(((Email) other).value)); // state check
     }
-
-    @Override
-    public int hashCode() {
-        return value.hashCode();
-    }
-
-
-    public boolean isPrivate() {
-        return isPrivate;
-    }
-}
+}

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

@@ -14,7 +14,6 @@ public class Name {
     public static final String EXAMPLE = "John Doe";
     public static final String MESSAGE_NAME_CONSTRAINTS = "Person names should be spaces or alphabetic characters";
     public static final String NAME_VALIDATION_REGEX = "[\\p{Alpha} ]+";
-
     public final String fullName;
 
     /**
@@ -23,11 +22,11 @@ public class Name {
      * @throws IllegalValueException if given name string is invalid.
      */
     public Name(String name) throws IllegalValueException {
-        name = name.trim();
-        if (!isValidName(name)) {
+        String trimmedName = name.trim();
+        if (!isValidName(trimmedName)) {
             throw new IllegalValueException(MESSAGE_NAME_CONSTRAINTS);
         }
-        this.fullName = name;
+        this.fullName = trimmedName;
     }
 
     /**