Add Javadocs

yyihaoc · Oct 16, 2024 · 26c2473 · 26c2473
1 parent 32bfe2b
commit 26c2473
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 19 deletions.
diff --git a/src/main/java/seedu/address/logic/parser/FindCommandParser.java b/src/main/java/seedu/address/logic/parser/FindCommandParser.java
@@ -37,6 +37,10 @@ public FindCommand parse(String args) throws ParseException {
                 new RoleContainsKeywordsPredicate(roleKeywords));
     }
 
+    /**
+     * Returns true if any of the prefixes contains non-empty {@code Optional} values in the given
+     * {@code ArgumentMultimap}.
+     */
     public static boolean areSomePrefixesPresent(ArgumentMultimap argumentMultimap, Prefix... prefixes) {
         return Stream.of(prefixes).anyMatch(prefix -> argumentMultimap.getValue(prefix).isPresent());
     }

diff --git a/src/main/java/seedu/address/model/person/Person.java b/src/main/java/seedu/address/model/person/Person.java
@@ -6,7 +6,6 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
-import java.util.List;
 import java.util.Objects;
 import java.util.Set;
 
@@ -24,25 +23,12 @@ public class Person {
     private final Phone phone;
     private final Email email;
     private final Telegram telegram;
-    // private List<Role> roles;
 
     // Data fields
     private final Set<Tag> tags = new HashSet<>();
 
     /**
      * Every field must be present and not null.
-     */
-    /*
-    public Person(Name name, Phone phone, Email email, Telegram telegram, List<Role> roles, Set<Tag> tags) {
-        requireAllNonNull(name, phone, email, telegram, tags);
-        this.name = name;
-        this.phone = phone;
-        this.email = email;
-        this.telegram = telegram;
-        this.roles = roles;
-        this.tags.addAll(tags);
-    }
-
      */
     public Person(Name name, Phone phone, Email email, Telegram telegram, Set<Tag> tags) {
         requireAllNonNull(name, phone, email, telegram, tags);
@@ -69,8 +55,6 @@ public Telegram getTelegram() {
         return telegram;
     }
 
-    // public List<Role> getRoles() {return roles;}
-
     /**
      * Returns an immutable tag set, which throws {@code UnsupportedOperationException}
      * if modification is attempted.

diff --git a/src/main/java/seedu/address/model/person/RoleContainsKeywordsPredicate.java b/src/main/java/seedu/address/model/person/RoleContainsKeywordsPredicate.java
@@ -7,6 +7,9 @@
 import seedu.address.commons.util.ToStringBuilder;
 import seedu.address.model.tag.Tag;
 
+/**
+ * Tests that a {@code Person}'s {@code Role} matches any of the keywords given.
+ */
 public class RoleContainsKeywordsPredicate implements Predicate<Person> {
     private final List<String> keywords;
 
@@ -17,7 +20,6 @@ public RoleContainsKeywordsPredicate(List<String> keywords) {
     @Override
     public boolean test(Person person) {
         return keywords.stream()
-               // .anyMatch(keyword -> person.getRoles().stream().anyMatch(role -> role.equals(new Role(keyword))));
                 .anyMatch(keyword -> person.getTags().stream().anyMatch(x -> x.equals(new Tag(keyword))));
     }
 

diff --git a/src/main/java/seedu/address/model/tag/Tag.java b/src/main/java/seedu/address/model/tag/Tag.java
@@ -44,9 +44,8 @@ public boolean equals(Object other) {
         }
 
         Tag otherTag = (Tag) other;
-        // return tagName.equals(otherTag.tagName);
-        return tagName.equalsIgnoreCase(otherTag.tagName);
 
+        return tagName.equalsIgnoreCase(otherTag.tagName);
     }
 
     @Override