[#188] Adopt a uniform toString() format

src/main/java/seedu/address/AppParameters.java

@@ -9,6 +9,7 @@
 import javafx.application.Application;
 import seedu.address.commons.core.LogsCenter;
 import seedu.address.commons.util.FileUtil;
+import seedu.address.commons.util.ToStringBuilder;
 
 /**
  * Represents the parsed command-line parameters given to the application.
@@ -61,4 +62,11 @@ public boolean equals(Object other) {
     public int hashCode() {
         return configPath.hashCode();
     }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .add("configPath", configPath)
+                .toString();
+    }
 }

src/main/java/seedu/address/commons/core/Config.java

@@ -5,6 +5,8 @@
 import java.util.Objects;
 import java.util.logging.Level;
 
+import seedu.address.commons.util.ToStringBuilder;
+
 /**
  * Config values used by the app
  */
@@ -54,10 +56,10 @@ public int hashCode() {
 
     @Override
     public String toString() {
-        StringBuilder sb = new StringBuilder();
-        sb.append("Current log level : " + logLevel);
-        sb.append("\nPreference file Location : " + userPrefsFilePath);
-        return sb.toString();
+        return new ToStringBuilder(this)
+                .add("logLevel", logLevel)
+                .add("userPrefsFilePath", userPrefsFilePath)
+                .toString();
     }
 
 }

src/main/java/seedu/address/commons/core/GuiSettings.java

@@ -4,6 +4,8 @@
 import java.io.Serializable;
 import java.util.Objects;
 
+import seedu.address.commons.util.ToStringBuilder;
+
 /**
  * A Serializable class that contains the GUI settings.
  * Guarantees: immutable.
@@ -70,10 +72,10 @@ public int hashCode() {
 
     @Override
     public String toString() {
-        StringBuilder sb = new StringBuilder();
-        sb.append("Width : " + windowWidth + "\n");
-        sb.append("Height : " + windowHeight + "\n");
-        sb.append("Position : " + windowCoordinates);
-        return sb.toString();
+        return new ToStringBuilder(this)
+                .add("windowWidth", windowWidth)
+                .add("windowHeight", windowHeight)
+                .add("windowCoordinates", windowCoordinates)
+                .toString();
     }
 }

src/main/java/seedu/address/commons/core/Messages.java

@@ -1,5 +1,7 @@
 package seedu.address.commons.core;
 
+import seedu.address.model.person.Person;
+
 /**
  * Container for user visible messages.
  */
@@ -10,4 +12,21 @@ public class Messages {
     public static final String MESSAGE_INVALID_PERSON_DISPLAYED_INDEX = "The person index provided is invalid";
     public static final String MESSAGE_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";
 
+    /**
+     * Formats the {@code person} for display to the user.
+     */
+    public static String format(Person person) {
+        final StringBuilder builder = new StringBuilder();
+        builder.append(person.getName())
+                .append("; Phone: ")
+                .append(person.getPhone())
+                .append("; Email: ")
+                .append(person.getEmail())
+                .append("; Address: ")
+                .append(person.getAddress())
+                .append("; Tags: ");
+        person.getTags().forEach(builder::append);
+        return builder.toString();
+    }
+
 }

src/main/java/seedu/address/commons/core/index/Index.java

@@ -1,5 +1,7 @@
 package seedu.address.commons.core.index;
 
+import seedu.address.commons.util.ToStringBuilder;
+
 /**
  * Represents a zero-based or one-based index.
  *
@@ -51,4 +53,9 @@ public boolean equals(Object other) {
                 || (other instanceof Index // instanceof handles nulls
                 && zeroBasedIndex == ((Index) other).zeroBasedIndex); // state check
     }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this).add("zeroBasedIndex", zeroBasedIndex).toString();
+    }
 }

src/main/java/seedu/address/commons/util/ToStringBuilder.java

@@ -0,0 +1,53 @@
+package seedu.address.commons.util;
+
+/**
+ * Builds a string representation of an object that is suitable as the return value of {@link Object#toString()}.
+ */
+public class ToStringBuilder {
+    private static final String OBJECT_PREFIX = "{";
+    private static final String OBJECT_SUFFIX = "}";
+    private static final String FIELD_SEPARATOR = ", ";
+    private static final String FIELD_NAME_VALUE_SEPARATOR = "=";
+
+    private final StringBuilder stringBuilder = new StringBuilder();
+    private boolean hasField;
+
+    /**
+     * Constructs a {@code ToStringBuilder} whose formatted output will be prefixed with {@code objectName}.
+     */
+    public ToStringBuilder(String objectName) {
+        stringBuilder.append(objectName).append(OBJECT_PREFIX);
+    }
+
+    /**
+     * Constructs a {@code ToStringBuilder} whose formatted output will be prefixed with the
+     * canonical class name of {@code object}.
+     */
+    public ToStringBuilder(Object object) {
+        this(object.getClass().getCanonicalName());
+    }
+
+    /**
+     * Adds a field name/value pair to the output string.
+     *
+     * @param fieldName The name of the field.
+     * @param fieldValue The value of the field.
+     * @return A reference to this {@code ToStringBuilder} object, allowing method calls to be chained.
+     */
+    public ToStringBuilder add(String fieldName, Object fieldValue) {
+        if (hasField) {
+            stringBuilder.append(FIELD_SEPARATOR);
+        }
+        stringBuilder.append(fieldName).append(FIELD_NAME_VALUE_SEPARATOR).append(fieldValue);
+        hasField = true;
+        return this;
+    }
+
+    /**
+     * Returns the built formatted string representation.
+     */
+    @Override
+    public String toString() {
+        return stringBuilder.toString() + OBJECT_SUFFIX;
+    }
+}

src/main/java/seedu/address/logic/commands/AddCommand.java

@@ -7,6 +7,8 @@
 import static seedu.address.logic.parser.CliSyntax.PREFIX_PHONE;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG;
 
+import seedu.address.commons.core.Messages;
+import seedu.address.commons.util.ToStringBuilder;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.person.Person;
@@ -55,7 +57,7 @@ public CommandResult execute(Model model) throws CommandException {
         }
 
         model.addPerson(toAdd);
-        return new CommandResult(String.format(MESSAGE_SUCCESS, toAdd));
+        return new CommandResult(String.format(MESSAGE_SUCCESS, Messages.format(toAdd)));
     }
 
     @Override
@@ -64,4 +66,11 @@ public boolean equals(Object other) {
                 || (other instanceof AddCommand // instanceof handles nulls
                 && toAdd.equals(((AddCommand) other).toAdd));
     }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .add("toAdd", toAdd)
+                .toString();
+    }
 }

src/main/java/seedu/address/logic/commands/CommandResult.java

@@ -4,6 +4,8 @@
 
 import java.util.Objects;
 
+import seedu.address.commons.util.ToStringBuilder;
+
 /**
  * Represents the result of a command execution.
  */
@@ -68,4 +70,13 @@ public int hashCode() {
         return Objects.hash(feedbackToUser, showHelp, exit);
     }
 
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .add("feedbackToUser", feedbackToUser)
+                .add("showHelp", showHelp)
+                .add("exit", exit)
+                .toString();
+    }
+
 }

src/main/java/seedu/address/logic/commands/DeleteCommand.java

@@ -6,6 +6,7 @@
 
 import seedu.address.commons.core.Messages;
 import seedu.address.commons.core.index.Index;
+import seedu.address.commons.util.ToStringBuilder;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.person.Person;
@@ -41,7 +42,7 @@ public CommandResult execute(Model model) throws CommandException {
 
         Person personToDelete = lastShownList.get(targetIndex.getZeroBased());
         model.deletePerson(personToDelete);
-        return new CommandResult(String.format(MESSAGE_DELETE_PERSON_SUCCESS, personToDelete));
+        return new CommandResult(String.format(MESSAGE_DELETE_PERSON_SUCCESS, Messages.format(personToDelete)));
     }
 
     @Override
@@ -50,4 +51,11 @@ public boolean equals(Object other) {
                 || (other instanceof DeleteCommand // instanceof handles nulls
                 && targetIndex.equals(((DeleteCommand) other).targetIndex)); // state check
     }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .add("targetIndex", targetIndex)
+                .toString();
+    }
 }

src/main/java/seedu/address/logic/commands/EditCommand.java

@@ -17,6 +17,7 @@
 import seedu.address.commons.core.Messages;
 import seedu.address.commons.core.index.Index;
 import seedu.address.commons.util.CollectionUtil;
+import seedu.address.commons.util.ToStringBuilder;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.person.Address;
@@ -83,7 +84,7 @@ public CommandResult execute(Model model) throws CommandException {
 
         model.setPerson(personToEdit, editedPerson);
         model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
-        return new CommandResult(String.format(MESSAGE_EDIT_PERSON_SUCCESS, editedPerson));
+        return new CommandResult(String.format(MESSAGE_EDIT_PERSON_SUCCESS, Messages.format(editedPerson)));
     }
 
     /**
@@ -120,6 +121,14 @@ public boolean equals(Object other) {
                 && editPersonDescriptor.equals(e.editPersonDescriptor);
     }
 
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .add("index", index)
+                .add("editPersonDescriptor", editPersonDescriptor)
+                .toString();
+    }
+
     /**
      * Stores the details to edit the person with. Each non-empty field value will replace the
      * corresponding field value of the person.
@@ -222,5 +231,16 @@ && getEmail().equals(e.getEmail())
                     && getAddress().equals(e.getAddress())
                     && getTags().equals(e.getTags());
         }
+
+        @Override
+        public String toString() {
+            return new ToStringBuilder(this)
+                    .add("name", name)
+                    .add("phone", phone)
+                    .add("email", email)
+                    .add("address", address)
+                    .add("tags", tags)
+                    .toString();
+        }
     }
 }

src/main/java/seedu/address/logic/commands/FindCommand.java

@@ -3,6 +3,7 @@
 import static java.util.Objects.requireNonNull;
 
 import seedu.address.commons.core.Messages;
+import seedu.address.commons.util.ToStringBuilder;
 import seedu.address.model.Model;
 import seedu.address.model.person.NameContainsKeywordsPredicate;
 
@@ -39,4 +40,11 @@ public boolean equals(Object other) {
                 || (other instanceof FindCommand // instanceof handles nulls
                 && predicate.equals(((FindCommand) other).predicate)); // state check
     }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .add("predicate", predicate)
+                .toString();
+    }
 }

src/main/java/seedu/address/logic/parser/Prefix.java

@@ -15,6 +15,7 @@ public String getPrefix() {
         return prefix;
     }
 
+    @Override
     public String toString() {
         return getPrefix();
     }

src/main/java/seedu/address/model/AddressBook.java

@@ -5,6 +5,7 @@
 import java.util.List;
 
 import javafx.collections.ObservableList;
+import seedu.address.commons.util.ToStringBuilder;
 import seedu.address.model.person.Person;
 import seedu.address.model.person.UniquePersonList;
 
@@ -97,8 +98,9 @@ public void removePerson(Person key) {
 
     @Override
     public String toString() {
-        return persons.asUnmodifiableObservableList().size() + " persons";
-        // TODO: refine later
+        return new ToStringBuilder(this)
+                .add("persons", persons)
+                .toString();
     }
 
     @Override

src/main/java/seedu/address/model/person/NameContainsKeywordsPredicate.java

@@ -4,6 +4,7 @@
 import java.util.function.Predicate;
 
 import seedu.address.commons.util.StringUtil;
+import seedu.address.commons.util.ToStringBuilder;
 
 /**
  * Tests that a {@code Person}'s {@code Name} matches any of the keywords given.
@@ -28,4 +29,8 @@ public boolean equals(Object other) {
                 && keywords.equals(((NameContainsKeywordsPredicate) other).keywords)); // state check
     }
 
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this).add("keywords", keywords).toString();
+    }
 }