Added comments to the code

Author: Madhavan7

src/main/java/screens/user_registration_screen/UserRegistrationUI.java

@@ -26,6 +26,9 @@ public class UserRegistrationUI implements ActionListener, userRegCredentialsRet
     public UserRegistrationUI(UserExistsInputBoundary existsInputBoundary) {
         this.verifyUser = existsInputBoundary;
     }
+    /**
+     * Creates the frame on which the user inputs account registration credentials
+     * **/
     @Override
     public void getUserCredentials(){
         //Front end related objects
@@ -97,6 +100,7 @@ public void actionPerformed(ActionEvent e) {
         String password = passwordText.getText();
         String email = emailText.getText();
 
+        // Makes sure that the credentials entered are of the correct format, may use regex to correct this
         if(username.equals("")|| password.equals("")|| email.equals("")){
             missingCredentials();
         }else{
@@ -105,7 +109,9 @@ public void actionPerformed(ActionEvent e) {
             verifyUser.register(username, password, email);
         }
     }
-
+    /**
+     * The frame that shows up when the credentials entered are not of the right format
+     * **/
     public void missingCredentials(){
         JFrame credentialsMissing = new JFrame();
         credentialsMissing.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);

src/main/java/use_cases/user_registration_use_cases/EmailDelivery.java

@@ -4,12 +4,15 @@
 import javax.mail.*;
 import javax.mail.internet.InternetAddress;
 import javax.mail.internet.MimeMessage;
-
+/**
+ * This is the class that implements Email verification*/
 public class EmailDelivery implements ISendVerificationCode {
+    /**
+     * The method that implements email verification
+     * @param email Email address
+     * @param code  Verification Code
+     * */
     public void sendVerificationCode(String email, int code){
-        /*TODO: When this is implemented, the verification code will be sent to the email specified by String email*/
-        System.out.println("Verification code sent to " + email);
-
         //email address we will send the code to
         String to = email;
 
@@ -42,7 +45,6 @@ protected PasswordAuthentication getPasswordAuthentication() {
             message.setText("The verification code for your account is " + code + ". If this was not you, you can safely " +
                     "ignore this email");
             Transport.send(message);
-            System.out.println("success");
         } catch (MessagingException e) {
             throw new RuntimeException(e);
         }

src/main/java/use_cases/user_registration_use_cases/ISendVerificationCode.java

@@ -1,5 +1,7 @@
 package use_cases.user_registration_use_cases;
-//This is an output boundary object for the user registration use case.
+/**
+ * Interface that has a method which represents the sending of the verification code to the user
+ * */
 public interface ISendVerificationCode {
     void sendVerificationCode(String email, int code);
 }

src/main/java/use_cases/user_registration_use_cases/PhoneDelivery.java

@@ -1,8 +1,12 @@
 package use_cases.user_registration_use_cases;
 
-import use_cases.user_registration_use_cases.ISendVerificationCode;
-
+/**
+ * Class that represents Phone verification. Currently unimplemented
+ * */
 public class PhoneDelivery implements ISendVerificationCode {
+    /**
+     * The function that is supposed to implement phone verification. Currently unimplemented
+     * */
     public void sendVerificationCode(String phoneNumber, int code){
         /*TODO: When this is implemented properly, the verification code will be sent to phone number specified by
         *  String phoneNumber*/

src/main/java/use_cases/user_registration_use_cases/UserCreator.java

@@ -1,5 +1,8 @@
 
 package use_cases.user_registration_use_cases;
+/**
+ * Interface that has a method which represents the creation of a user
+ * */
 public interface UserCreator {
     void createUser(String username, String password, String email, String type);
 }

src/main/java/use_cases/user_registration_use_cases/UserExists.java

@@ -1,6 +1,15 @@
 
 package use_cases.user_registration_use_cases;
 public interface UserExists {
+    /**
+     * Method that checks if a user exists in the database
+     * @param email Email address of the user
+     * @param username Username of the user
+     * */
     boolean UserExists(String username, String email);
+    /**
+     * Method that checks if a user exists in the database
+     * @param username Username of the user
+     * */
     boolean UserExists(String username);
 }

src/main/java/use_cases/user_registration_use_cases/UserExistsInputBoundary.java

@@ -4,6 +4,4 @@ public interface UserExistsInputBoundary {
 
     void register(String username, String password, String email);
     void setCodeDeliveryMethod(String type);
-
-    void setOutputBoundary(UserExistsOutputBoundary existsOutputBoundary);
 }

src/main/java/use_cases/user_registration_use_cases/UserExistsInteractor.java

@@ -2,8 +2,10 @@
 
 import data_access.Database;
 
-import java.util.Random;
-
+/**
+ * This is the class responsible for getting processing the input given by user, and either allowing verification,
+ * presenting the 'user exists' message, and sending the verification code, depending on the business logic
+ * */
 public class UserExistsInteractor implements UserExistsInputBoundary{
     private final VerificationCodeDeliveryManager verCodeDeliveryManager;
     Database database;
@@ -15,9 +17,17 @@ public UserExistsInteractor(Database database, UserExistsOutputBoundary existsOu
         //The responsibility of dealing with verification is passed onto this class
         this.verCodeDeliveryManager = new VerificationCodeDeliveryManager(mailMan);
     }
+    /**
+     * Proceeds to verification and sends code, or presents an error message, depending on whether a user with
+     * such credentials is in the database.
+     * @param username Username
+     * @param email Email
+     * @param password Password
+     * */
     @Override
     public void register(String username, String password, String email) {
         if(!database.UserExists(username, email)){
+            //This may need to change if verCodeDeliveryManager decides not to create integer codes.
             int code = this.verCodeDeliveryManager.getVerCode();
             existsOutputBoundary.getCode(code);
             existsOutputBoundary.getUserCredentials(username, password, email);
@@ -27,14 +37,12 @@ public void register(String username, String password, String email) {
             existsOutputBoundary.presentUserExistsMessage();
         }
     }
-
+    /**
+     * Sets the verification stream given by the user, to send the code
+     * @param type The verification stream
+     * */
     @Override
     public void setCodeDeliveryMethod(String type) {
         this.verCodeDeliveryManager.setMailMan(type);
     }
-
-    @Override
-    public void setOutputBoundary(UserExistsOutputBoundary existsOutputBoundary) {
-        this.existsOutputBoundary = existsOutputBoundary;
-    }
 }

src/main/java/use_cases/user_registration_use_cases/UserExistsOutputBoundary.java

@@ -1,8 +1,26 @@
 package use_cases.user_registration_use_cases;
-
+/**
+ * Presenter interface that presents information, or gets input from user
+ * */
 public interface UserExistsOutputBoundary {
+    /**
+     * Gets the verification code from the user
+     * */
     void getVerificationCredentials();
+    /**
+     * Presents that the user exists in the database
+     * */
     void presentUserExistsMessage();
+    /**
+     * Gets the code from the input boundary object
+     * @param code Verification code
+     * */
     void getCode(int code);
+    /**
+     * Gets the user credentials from the input boundary object
+     * @param email Email address of the user
+     * @param password Password of the user
+     * @param username Username of the user
+     * */
     void getUserCredentials(String username, String password, String email);
 }

src/main/java/use_cases/user_registration_use_cases/VerificationCodeDeliveryManager.java

@@ -1,7 +1,10 @@
 package use_cases.user_registration_use_cases;
 
 import java.util.Random;
-
+/**
+ * This class is responsible for managing aspects related to verification, such as creating the verification code
+ * and sending the code to the user
+ * */
 public class VerificationCodeDeliveryManager {
     private final int code = new Random().nextInt(134134);
     private final createMailMan mailManFactory;
@@ -11,12 +14,23 @@ public VerificationCodeDeliveryManager(createMailMan mailManFactory){
         //By default, the type will be email.
         this.setMailMan("Email");
     }
+    /**
+     * Sets the verification stream
+     * @param type String that represents how the code is delivered
+     * */
     public void setMailMan(String type){
         this.mailMan = mailManFactory.getVerificationMethod(type);
     }
+    /**
+     * Sends the verification code
+     * @param email Represents the email
+     * */
     public void deliverCode(String email){
         this.mailMan.sendVerificationCode(email, this.code);
     }
+    /**
+     * returns the verification code
+     * */
     public int getVerCode(){
         return this.code;
     }