Added more documenation for getters, setters and testing.

Author: uoftguy

src/main/java/entities/CommonUser.java

@@ -33,34 +33,61 @@ public CommonUser(String username, String password, boolean isAdmin){
         this.flashcardSetIds = new ArrayList<>();
     }
 
-    //GETTERS AND SETTERS
+    /**
+     * Gets the username of the user
+     * @return the username of the user
+     */
     @Override
     public String getUsername() {
         return username;
     }
 
+    /**
+     * Sets the username of the user to be as given.
+     * @param username the username of the use
+     */
     public void setUsername(String username) {
         this.username = username;
     }
 
+    /**
+     * Gets the password of the user
+     * @return the password of the user
+     */
     @Override
     public String getPassword() {
         return password;
     }
 
+    /**
+     * Sets the password of the user to be as given.
+     * @param password the username of the use
+     */
     public void setPassword(String password) {
         this.password = password;
     }
 
+    /**
+     * Gets the admin access level of the user
+     * @return whether the user is an admin
+     */
     @Override
     public boolean getIsAdmin() {
         return isAdmin;
     }
 
+    /**
+     * Sets the level of admin access the user has
+     * @param isAdmin whether the user should obtain admin level access
+     */
     public void setIsAdmin(boolean isAdmin){
         this.isAdmin = isAdmin;
     }
 
+    /**
+     * Gets the list of flashcard set ids belonging to the user
+     * @return list of flashcard set ids
+     */
     @Override
     public ArrayList<Integer> getFlashcardSetIds() {
         return flashcardSetIds;
@@ -77,7 +104,7 @@ public boolean passwordIsValid() {
 
     /**
      * Checks whether the admin key entered is similar to the actual admin key in the business rules
-     * @param adminKey the username of the use
+     * @param adminKey the username of the user
      * @return whether the admin is the same as the one stored in the enterprise rules
      */
     @Override

src/main/java/entities/User.java

@@ -10,20 +10,27 @@
  */
 public interface User {
     String username = null;
-
     String password = null;
     boolean isAdmin = false;
-    String ADMIN_KEY = "BuiltDifferent";
-
-    //Map<Integer, String[]> flashcardSets = null;
-    ArrayList<Integer> flashcardSetIds = null;
 
+    /**
+     * Gets the username belonging to the user
+     */
     String getUsername();
 
+    /**
+     * Gets the password belonging to the user
+     */
     String getPassword();
 
+    /**
+     * Gets whether the user is an admin user
+     */
     boolean getIsAdmin();
 
+    /**
+     * Gets the list of flashcard set ids belonging to the user
+     */
     ArrayList<Integer> getFlashcardSetIds();
 
     /**

src/main/java/login_and_signup_use_case/UserLoginRequestModel.java

@@ -21,12 +21,17 @@ public UserLoginRequestModel(String username, String password) {
     }
 
     /**
-     * GETTERS AND SETTERS
+     * Gets the inputted username of the user
+     * @return the username that the user inputted
      */
     String getUsername() {
         return username;
     }
 
+    /**
+     * Sets the inputted password of the user to be as given.
+     * @return the password that the user inputted
+     */
     String getPassword() {
         return password;
     }

src/main/java/login_and_signup_use_case/UserLoginResponseModel.java

@@ -28,13 +28,24 @@ public UserLoginResponseModel(String loggedInUsername, boolean isAdmin, Map<Inte
     }
 
     /**
-     * GETTERS for the system
+     * Gets the username of the user as saved in the database
+     * @return the username that the user stored
      */
     public String getSignedInUsername() {
         return username;
     }
+
+    /**
+     * Gets whether the user is saved as an admin in the database
+     * @return the admin level access of the user as stored in the database
+     */
     public boolean getIsAdmin(){return isAdmin;}
 
+    /**
+     * Gets the list of flashcard set ids belonging to the user and onverts it into a map with the id as
+     * a key and the title and description of the flashcard set as the value in a string array format
+     * @return map of the flashcard sets belonging to the user
+     */
     public Map<Integer, String[]> getFlashcardSets(){
 
         return flashcardSets;

src/main/java/login_and_signup_use_case/UserRegisterInteractor.java

@@ -42,7 +42,7 @@ public UserRegisterResponseModel create(UserRegisterRequestModel requestModel) {
         // Create a temporary user to access the adminkey
         User fakeUser = userFactory.create("BLANK", "BLANK1", false);
 
-        // set isAdmin to true if they entered the admin key correctly
+        // Set isAdmin to true if they entered the admin key correctly
         boolean isAdmin = fakeUser.adminKeyValid(requestModel.getAdminKeyEntered());
 
         User user = userFactory.create(requestModel.getName(), requestModel.getPassword(), isAdmin);

src/main/java/login_and_signup_use_case/UserRegisterRequestModel.java

@@ -30,20 +30,34 @@ public UserRegisterRequestModel(String name, String password, String repeatPassw
     }
 
     /**
-     * GETTERS for the UserRegisterRequestModel
+     * Gets the inputted name that the user opts to be as their username.
+     * @return the username that the user inputted.
      */
     String getName() {
         return name;
     }
 
+    /**
+     * Gets the inputted password that the user opts to be as their password.
+     * @return the password that the user inputted.
+     */
     String getPassword() {
         return password;
     }
 
+    /**
+     * Gets the inputted repeated password that the user opts to be as their password again to ensure that
+     * they are sure of the password and that it matches their previously inputted password.
+     * @return the password that the user inputted.
+     */
     public String getRepeatPassword() {
         return repeatPassword;
     }
 
+    /**
+     * Gets the admin key that the user has inputted to check whether they should be given admin level access.
+     * @return the admin key inputted by the user.
+     */
     public String getAdminKeyEntered() {
         return adminKeyEntered;
     }

src/main/java/login_and_signup_use_case/UserRegisterResponseModel.java

@@ -26,15 +26,25 @@ public UserRegisterResponseModel(String signedUpUsername, String signedUpPasswor
     }
 
     /**
-     * GETTERS for the UserRegisterResponseModel
+     * Gets the username of the user as it would be saved in the database.
+     * @return the username assigned to the user for their account.
      */
     public String getSignedUpUsername() {
         return signedUpUsername;
     }
 
+    /**
+     * Gets the password of the user as it would be saved in the database.
+     * @return the password assigned to the user for their account.
+     */
     public String getSignedUpPassword(){
         return signedUpPassword;
     }
+
+    /**
+     * Gets the admin level access of the user as it would be saved in the database.
+     * @return whether the user is assigned admin level access for their account.
+     */
     public boolean getIsAdmin(){return isAdmin;}
 
 }

src/test/java/login_and_sign_up_use_case_test/InMemoryUser.java

@@ -7,34 +7,59 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Mock database created in order to test the register test case with a temporary database.
+ */
 public class InMemoryUser implements IUserDataAccess {
 
     final private Map<String, CommonUserDsRequestModel> users = new HashMap<>();
+
+    /**
+     * Disregarding methods from the actual database classes irrelevant to the mock database.
+     * @return null since the method isn't applicable to the mock database
+     */
     @Override
     public CommonUserDsRequestModel getUser(String username) {
         return null;
     }
 
+    /**
+     * Mimic the act of checking whether a user exists in the database.
+     * @return whether the user exists in the mock database.
+     */
     @Override
     public boolean existsByName(String username) {
         return users.containsKey(username);
     }
 
+    /**
+     * Disregarding methods from the actual database classes irrelevant to the mock database.
+     * @return null since the method isn't applicable to the mock database
+     */
     @Override
     public Collection<CommonUserDsRequestModel> getAllUsers() {
         return null;
     }
 
+    /**
+     * Disregarding methods from the actual database classes irrelevant to the mock database.
+     */
     @Override
     public void saveFlashcardSetID(String username, int FlashcardSetID) {
 
     }
 
+    /**
+     * Disregarding methods from the actual database classes irrelevant to the mock database.
+     */
     @Override
     public void deleteFlashcardSetID(String username, int FlashcardSetID) {
 
     }
 
+    /**
+     * Mimic the act of saving a user as the database
+     */
     @Override
     public void saveUser(CommonUserDsRequestModel user) {
         System.out.println("Save " + user.getUsername());