Added Javadocs for all classes and methods pertaining to delete a flashcard set use case.

Author: Edward-1117

src/main/java/delete_flashcard_set_use_case/DelFlashcardSetController.java

@@ -2,17 +2,33 @@
 
 // Interface adapters (Green) layer
 
+/**
+ * The controller for flashcard set deletion.
+ *
+ * @author Edward Ishii
+ */
 public class DelFlashcardSetController {
 
-    DelFlashcardSetInputBoundary userInput;
+    DelFlashcardSetInputBoundary interactor;
 
-    public DelFlashcardSetController(DelFlashcardSetInputBoundary userInput) {
-        this.userInput = userInput;
+    /**
+     * Constructs a new DelFlashcardSetController.
+     *
+     * @param interactor the use case interactor for deleting flashcard sets.
+     */
+    public DelFlashcardSetController(DelFlashcardSetInputBoundary interactor) {
+        this.interactor = interactor;
     }
 
+    /**
+     * Deletes a flashcard set (and all the flashcards contained within it) from the database.
+     *
+     * @param flashcardSetId the id of the flashcard set to be deleted.
+     * @return the response model containing the deletion message.
+     */
     DelFlashcardSetResponseModel delete(int flashcardSetId) {
         DelFlashcardSetRequestModel requestModel = new DelFlashcardSetRequestModel(flashcardSetId);
 
-        return userInput.delete(requestModel);
+        return interactor.delete(requestModel);
     }
 }

src/main/java/delete_flashcard_set_use_case/DelFlashcardSetInputBoundary.java

@@ -1,5 +1,17 @@
 package delete_flashcard_set_use_case;
 
+/**
+ * The input boundary interface for deleting flashcard sets.
+ *
+ * @author Edward Ishii
+ */
 public interface DelFlashcardSetInputBoundary {
+
+    /**
+     * Delete the flashcard set (and all the flashcards contained within it) from the database.
+     *
+     * @param requestModel the request model required for flashcard set deletion (i.e., the id).
+     * @return the response model containing the deletion message.
+     */
     DelFlashcardSetResponseModel delete(DelFlashcardSetRequestModel requestModel);
 }

src/main/java/delete_flashcard_set_use_case/DelFlashcardSetInteractor.java

@@ -1,9 +1,9 @@
 package delete_flashcard_set_use_case;
 
-// Use case (Red) layer
-
 import data_access.DBGateway;
 
+// Use case (Red) layer
+
 /**
  * [Feature: Deleting a Flashcard Set]
  * UI:
@@ -14,20 +14,33 @@
  * - check that the flashcard set exists in the database (if not alert the user)
  * - if it exists, ask for confirmation to delete from the user
  * - notify successful deletion of flashcard set to the user
+ *
+ * @author Edward Ishii
  */
-
 public class DelFlashcardSetInteractor implements DelFlashcardSetInputBoundary {
 
     DBGateway dbGateway;
 
     DelFlashcardSetOutputBoundary outputBoundary;
 
+    /**
+     * Constructs the use case interactor.
+     *
+     * @param dbGateway      the database to modify so that the flashcard set is deleted.
+     * @param outputBoundary the output boundary that prepares the success/fail view of deleting flashcard sets.
+     */
     public DelFlashcardSetInteractor(DBGateway dbGateway, DelFlashcardSetOutputBoundary outputBoundary) {
         this.dbGateway = dbGateway;
         this.outputBoundary = outputBoundary;
     }
 
-    // Alternative constructor for testing purposes
+//    /**
+//     * Alternative constructor for testing purposes.
+//     *
+//     * @param flashcardSetDataAccess the flashcard set database.
+//     * @param flashcardDataAccess    the flashcard database.
+//     * @param outputBoundary         the output boundary for preparing success/fail view.
+//     */
 //    public DelFlashcardSetInteractor(IFlashcardSetDataAccess flashcardSetDataAccess,
 //                                     IFlashcardDataAccess flashcardDataAccess,
 //                                     DelFlashcardSetOutputBoundary outputBoundary) {
@@ -36,6 +49,12 @@ public DelFlashcardSetInteractor(DBGateway dbGateway, DelFlashcardSetOutputBound
 //        this.outputBoundary = outputBoundary;
 //    }
 
+    /**
+     * Delete the flashcard set (and all the flashcards contained within it) from the database.
+     *
+     * @param requestModel the request model required for flashcard set deletion (i.e., the id).
+     * @return the response model that contains the deletion message.
+     */
     @Override
     public DelFlashcardSetResponseModel delete(DelFlashcardSetRequestModel requestModel) {
 

src/main/java/delete_flashcard_set_use_case/DelFlashcardSetOutputBoundary.java

@@ -2,9 +2,27 @@
 
 // Use case (Red) layer
 
+/**
+ * The output boundary interface that updates the view when deleting a flashcard set succeeds or fails.
+ *
+ * @author Edward Ishii
+ */
 public interface DelFlashcardSetOutputBoundary {
 
+    /**
+     * Prepares the success view when flashcard set deletion succeeds.
+     *
+     * @param message the confirmation of deletion message.
+     * @return the response model containing the deletion message.
+     */
     DelFlashcardSetResponseModel prepareSuccessView(String message);
 
+    /**
+     * Prepares the failure view when flashcard set deletion fails.
+     *
+     * @param error the error message.
+     * @return the response model containing the error message.
+     * @throws FlashcardSetNotFound the error thrown when the flashcard set to be deleted is not found in the database.
+     */
     DelFlashcardSetResponseModel prepareFailView(String error) throws FlashcardSetNotFound;
 }

src/main/java/delete_flashcard_set_use_case/DelFlashcardSetPresenter.java

@@ -2,13 +2,31 @@
 
 // Interface adapters (Green) layer
 
+/**
+ * The presenter that updates the view when deleting a flashcard set succeeds or fails.
+ *
+ * @author Edward Ishii
+ */
 public class DelFlashcardSetPresenter implements DelFlashcardSetOutputBoundary {
 
+    /**
+     * Prepares the success view when flashcard set deletion succeeds.
+     *
+     * @param message the confirmation of deletion message.
+     * @return the response model containing the deletion message.
+     */
     @Override
     public DelFlashcardSetResponseModel prepareSuccessView(String message) {
         return new DelFlashcardSetResponseModel(message);
     }
 
+    /**
+     * Prepares the failure view when flashcard set deletion fails.
+     *
+     * @param error the error message.
+     * @return the response model containing the error message.
+     * @throws FlashcardSetNotFound the error thrown when the flashcard set to be deleted is not found in the database.
+     */
     @Override
     public DelFlashcardSetResponseModel prepareFailView(String error) {
         throw new FlashcardSetNotFound(error);

src/main/java/delete_flashcard_set_use_case/DelFlashcardSetRequestModel.java

@@ -2,18 +2,38 @@
 
 // Use case (Red) layer
 
+/**
+ * The request model required for deleting a flashcard set.
+ *
+ * @author Edward Ishii
+ */
 public class DelFlashcardSetRequestModel {
 
     private int flashcardSetId;
 
+    /**
+     * Constructs the request model.
+     *
+     * @param flashcardSetId the id of the flashcard set to be deleted.
+     */
     public DelFlashcardSetRequestModel(int flashcardSetId) {
         this.flashcardSetId = flashcardSetId;
     }
 
+    /**
+     * Getter for the flashcard set id.
+     *
+     * @return the id of this flashcard set.
+     */
     public int getFlashcardSetId() {
         return flashcardSetId;
     }
 
+    /**
+     * Setter for the flashcard set id.
+     *
+     * @param flashcardSetId the new id of this flashcard set.
+     */
     public void setFlashcardSetId(int flashcardSetId) {
         this.flashcardSetId = flashcardSetId;
     }

src/main/java/delete_flashcard_set_use_case/DelFlashcardSetResponseModel.java

@@ -2,18 +2,39 @@
 
 // Use case (Red) layer
 
+
+/**
+ * The response model with the delete message when a flashcard set is deleted.
+ *
+ * @author Edward Ishii
+ */
 public class DelFlashcardSetResponseModel {
 
     private String message;
 
+    /**
+     * Constructs a DelFlashcardSetResponseModel.
+     *
+     * @param message the message to be displayed when a flashcard set is deleted.
+     */
     public DelFlashcardSetResponseModel(String message) {
         this.message = message;
     }
 
+    /**
+     * Getter for the delete message.
+     *
+     * @return the message displayed when a flashcard set is deleted.
+     */
     public String getMessage() {
-        return message;
+        return this.message;
     }
 
+    /**
+     * Setter for the delete message.
+     *
+     * @param message the new delete message to be displayed.
+     */
     public void setMessage(String message) {
         this.message = message;
     }

src/main/java/delete_flashcard_set_use_case/FlashcardSetNotFound.java

@@ -1,7 +1,18 @@
 package delete_flashcard_set_use_case;
 
+/**
+ * An exception class for when flashcard set deletion fails, specifically, the id of flashcard set to be
+ * deleted does not exist in the database.
+ *
+ * @author Edward Ishii
+ */
 public class FlashcardSetNotFound extends RuntimeException {
 
+    /**
+     * Throws a FlashcardSetNotFound error.
+     *
+     * @param error message of the error.
+     */
     public FlashcardSetNotFound(String error) {
         super(error);
     }

src/main/java/delete_flashcard_set_use_case/InMemoryFlashcard.java

@@ -5,6 +5,11 @@
 
 import java.util.ArrayList;
 
+/**
+ * A mock flashcard repository for testing purposes.
+ *
+ * @author Edward Ishii
+ */
 public class InMemoryFlashcard implements IFlashcardDataAccess {
 
     // Mock database
@@ -15,6 +20,10 @@ private boolean checkIds(int id1, int id2) {
         return id1 == id2;
     }
 
+    /**
+     * @param flashcardID the id of the flashcard.
+     * @return the flashcard associated with the id.
+     */
     @Override
     public FlashcardDsRequestModel getFlashcard(Integer flashcardID) {
         for (FlashcardDsRequestModel fc : flashcards) {
@@ -25,18 +34,28 @@ public FlashcardDsRequestModel getFlashcard(Integer flashcardID) {
         return null;
     }
 
+    /**
+     * @param flashcard the flashcard that is to be saved.
+     * @return the id of the flashcard that was saved.
+     */
     @Override
     public int saveFlashcard(FlashcardDsRequestModel flashcard) {
         flashcards.add(flashcard);
         System.out.println("Flashcard [" + flashcard.getTerm() + "] has been saved.");
         return flashcard.getFlashcardId();
     }
 
+    /**
+     * @param flashcard the flashcard that is to be edited.
+     */
     @Override
     public void editFlashcard(FlashcardDsRequestModel flashcard) {
 
     }
 
+    /**
+     * @param flashcardID the id of the flashcard.
+     */
     @Override
     public void deleteFlashcard(Integer flashcardID) {
         boolean deleted = false;