Fixed documentations.

Author: Junyu11111

src/main/java/create_flashcard_use_case/CreateFlashcardInteractor.java

@@ -13,7 +13,7 @@ public class CreateFlashcardInteractor implements CreateFlashcardInputBoundary {
     DBGateway gateway;
 
     /**
-     * Create FcCInteractor
+     * Create CreateFlashcardInteractor
      * @param gateway Database gateway.
      * @param presenter Presenter for failure or success view.
      */
@@ -23,8 +23,9 @@ public CreateFlashcardInteractor(DBGateway gateway, CreateFlashcardOutputBoundar
     }
 
     /**
-     * Create flashcard with given term, definition in the given flashcard set recording the date of creation.
-     * If term or definition is empty flashcard set does not exist, returns the corresponding error.
+     * Try to create a flashcard with the given term and definition in the given flashcard set, recording the date of creation.
+     * If the term or definition is empty flashcard set does not exist, return the corresponding error.
+     * If there is already a flashcard with the same term, return the response model representing the existing flashcard.
      * @return Success or failure view.
      */
     @Override
@@ -39,7 +40,7 @@ else if (gateway.getFlashcardSet(requestModel.getFlashcardSetId()) == null) {
         }
         for (int flashcardId : gateway.getFlashcardSet(requestModel.getFlashcardSetId()).getFlashcardIds()){
             if (gateway.getFlashcard(flashcardId).getTerm().equals(term)){
-                return presenter.prepareFailView(new CreateFlashcardResponseModel(LocalDateTime.now(), requestModel.getTerm(),
+                return presenter.prepareDuplicateView(new CreateFlashcardResponseModel(LocalDateTime.now(), requestModel.getTerm(),
                         gateway.getFlashcard(flashcardId).getDefinition(), flashcardId, true));
             }
         }
@@ -51,9 +52,25 @@ else if (gateway.getFlashcardSet(requestModel.getFlashcardSetId()) == null) {
 
     }
 
+
+    /**
+     * Try to create a flashcard with the given term and definition in the given flashcard set,
+     * overwrite the flashcard at flashcardId.
+     * If the term or definition is empty flashcard set does not exist, return the corresponding error.
+     * If there is already a flashcard with the same term, return the response model representing the existing flashcard.
+     * @param requestModel request model
+     * @param flashcardId flashcardId for the method to overwrite
+     * @return success or failure view
+     */
     public CreateFlashcardResponseModel create(CreateFlashcardRequestModel requestModel, int flashcardId){
         String term = requestModel.getTerm().replace("\n", " ").trim();
         String definition = requestModel.getDefinition().replace("\n", " ").trim();
+        if(term.isEmpty() || definition.isEmpty()){
+            return presenter.prepareFailView("Term or definition is empty.");
+        }
+        else if (gateway.getFlashcardSet(requestModel.getFlashcardSetId()) == null) {
+            return presenter.prepareFailView("Flashcard set does not exist.");
+        }
         LocalDateTime creationDate = LocalDateTime.now();
         gateway.editFlashcard(new FlashcardDsRequestModel(term, definition, creationDate, flashcardId,
                 requestModel.getFlashcardSetId()));

src/main/java/create_flashcard_use_case/CreateFlashcardOutputBoundary.java

@@ -7,5 +7,5 @@
 public interface CreateFlashcardOutputBoundary {
     CreateFlashcardResponseModel prepareSuccessView(CreateFlashcardResponseModel responseModel);
     CreateFlashcardResponseModel prepareFailView(String error);
-    CreateFlashcardResponseModel prepareFailView(CreateFlashcardResponseModel responseModel);
+    CreateFlashcardResponseModel prepareDuplicateView(CreateFlashcardResponseModel responseModel);
 }

src/main/java/create_flashcard_use_case/CreateFlashcardRequestModel.java

@@ -11,7 +11,7 @@ public class CreateFlashcardRequestModel {
     private String term, definition;
 
     /**
-     * Create FcCRequestModel
+     * Create CreateFlashcardRequestModel
      * @param flashcardSetId id of flashcard set which new flashcard will be added to
      * @param term term of the flashcard
      * @param definition definition of the flashcard

src/main/java/create_flashcard_use_case/CreateFlashcardResponseModel.java

@@ -13,12 +13,12 @@ public class CreateFlashcardResponseModel {
     private final Boolean existsDuplicate;
 
     /**
-     *Creating CreateFlashcardResponseModel for flashcard creation
+     *Create CreateFlashcardResponseModel for flashcard creation
      * @param creationDate date of creation
      * @param term term of the flashcard
      * @param definition definition of the flashcard
      * @param flashcardId flashcard id of the flashcard
-     * @param existsDuplicate if there is duplicate flashcard currently
+     * @param existsDuplicate if there is a duplicate flashcard currently
      */
     public CreateFlashcardResponseModel(LocalDateTime creationDate, String term, String definition, int flashcardId, Boolean existsDuplicate) {
         this.creationDate = creationDate;

src/main/java/delete_flashcard_use_case/DeleteFlashcardInteractor.java

@@ -14,7 +14,7 @@ public class DeleteFlashcardInteractor implements DeleteFlashcardInputBoundary {
     DBGateway gateway;
 
     /**
-     * Create FcRInteractor.
+     * Create DeleteFlashcardInteractor.
      * @param gateway Database gateway.
      * @param presenter presenter that prepares success or failure view.
      */

src/main/java/interface_adapters/controllers/CreateFlashcardController.java

@@ -24,6 +24,14 @@ public CreateFlashcardController(CreateFlashcardInputBoundary inputBoundary, int
         this.flashcardSetId = flashcardSetId;
     }
 
+    /**
+     * If flashcardId is -1, try to create a new flashcard.
+     * If flashcardId is not -1, try to create a new flashcard at the given flashcard id.
+     * @param term term of the flashcard
+     * @param definition definition of the flashcard
+     * @param flashcardId flashcard id to write to, -1 is a placeholder meaning no given flashcard id.
+     * @return CreateFlashcardResponseModel
+     */
     public CreateFlashcardResponseModel create(String term, String definition, int flashcardId){
         if (flashcardId == -1){
             return inputBoundary.create(new CreateFlashcardRequestModel(flashcardSetId, term, definition));

src/main/java/interface_adapters/controllers/DeleteFlashcardController.java

@@ -13,7 +13,7 @@ public class DeleteFlashcardController {
     DeleteFlashcardInputBoundary inputBoundary;
 
     /**
-     * Create FcRController.
+     * Create DeleteFlashcardController.
      * @param inputBoundary interactor for flashcard remover.
      */
     public DeleteFlashcardController(DeleteFlashcardInputBoundary inputBoundary){

src/main/java/interface_adapters/presenters/CreateFlashcardPresenter.java

@@ -36,7 +36,7 @@ public CreateFlashcardResponseModel prepareFailView(String error) {
      * @return the responseModel
      */
     @Override
-    public CreateFlashcardResponseModel prepareFailView(CreateFlashcardResponseModel responseModel) {
+    public CreateFlashcardResponseModel prepareDuplicateView(CreateFlashcardResponseModel responseModel) {
         return responseModel;
     }
 }