documentation

Author: anthony-chen-ca

src/main/java/quiz_use_case/QuizResponseModel.java

@@ -80,76 +80,91 @@ public QuizResponseModel(boolean failed, String message) {
         this.message = message;
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the failed value.
+     * @return true if response has failed
+     */
     public boolean isFailed() {
         return failed;
     }
 
-    public void setFailed(boolean failed) {
-        this.failed = failed;
-    }
-
+    /**
+     * Gets the message.
+     * @return the message
+     */
     public String getMessage() {
         return message;
     }
 
+    /**
+     * Sets the message.
+     * @param message the message
+     */
     public void setMessage(String message) {
         this.message = message;
     }
 
+    /**
+     * Returns true if the response needs confirmation from the user.
+     * @return need confirmation
+     */
     public boolean needToConfirm() {
         return needConfirmation;
     }
 
-    public void setNeedConfirmation(boolean needConfirmation) {
-        this.needConfirmation = needConfirmation;
-    }
-
+    /**
+     * Gets the score.
+     * @return the score
+     */
     public int getScore() {
         return score;
     }
 
-    public void setScore(int score) {
-        this.score = score;
-    }
-
+    /**
+     * Gets the number of questions.
+     * @return the number of questions
+     */
     public int getNumQuestions() {
         return numQuestions;
     }
 
-    public void setNumQuestions(int numQuestions) {
-        this.numQuestions = numQuestions;
-    }
-
+    /**
+     * Gets the list of question types.
+     * @return the types
+     */
     public List<String> getTypes() {
         return types;
     }
 
-    public void setTypes(List<String> types) {
-        this.types = types;
-    }
-
+    /**
+     * Gets the output text.
+     * @return the list of lists of output text
+     */
     public List<List<String>> getOutputText() {
         return outputText;
     }
 
+    /**
+     * Sets the output text.
+     * @param outputText the list of lists of output text
+     */
     public void setOutputText(List<List<String>> outputText) {
         this.outputText = outputText;
     }
 
+    /**
+     * Gets the user answers.
+     * @return the user answers
+     */
     public List<String> getUserAnswers() {
         return userAnswers;
     }
 
-    public void setUserAnswers(List<String> userAnswers) {
-        this.userAnswers = userAnswers;
-    }
-
+    /**
+     * Gets the actual answers.
+     * @return the actual answers
+     */
     public List<String> getActualAnswers() {
         return actualAnswers;
     }
-
-    public void setActualAnswers(List<String> actualAnswers) {
-        this.actualAnswers = actualAnswers;
-    }
 }

src/main/java/quiz_use_case/QuizSettingsRequestModel.java

@@ -44,59 +44,66 @@ public QuizSettingsRequestModel(int flashcardSetID) {
         this.flashcardSetID = flashcardSetID;
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the number of questions.
+     * @return the number of questions
+     */
     public int getNumQuestions() {
         return numQuestions;
     }
 
-    public void setNumQuestions(int numQuestions) {
-        this.numQuestions = numQuestions;
-    }
-
+    /**
+     * Gets the timer boolean value.
+     * @return true if the timer is on
+     */
     public boolean isTimerOn() {
         return timerOn;
     }
 
-    public void setTimerOn(boolean timerOn) {
-        this.timerOn = timerOn;
-    }
-
+    /**
+     * Gets the timer duration.
+     * @return the timer duration
+     */
     public int getTimerDuration() {
         return timerDuration;
     }
 
-    public void setTimerDuration(int timerDuration) {
-        this.timerDuration = timerDuration;
-    }
-
+    /**
+     * Gets the multiple choice boolean value.
+     * @return true if multiple choice is on
+     */
     public boolean isMultipleChoiceOn() {
         return multipleChoiceOn;
     }
 
-    public void setMultipleChoiceOn(boolean multipleChoiceOn) {
-        this.multipleChoiceOn = multipleChoiceOn;
-    }
-
+    /**
+     * Gets the text entry boolean value.
+     * @return true if text entry is on
+     */
     public boolean isTextEntryOn() {
         return textEntryOn;
     }
 
-    public void setTextEntryOn(boolean textEntryOn) {
-        this.textEntryOn = textEntryOn;
-    }
-
+    /**
+     * Gets the true/false boolean value.
+     * @return true if true/false is on
+     */
     public boolean isTrueFalseOn() {
         return trueFalseOn;
     }
 
-    public void setTrueFalseOn(boolean trueFalseOn) {
-        this.trueFalseOn = trueFalseOn;
-    }
-
+    /**
+     * Gets the flashcard set ID
+     * @return the flashcard set ID
+     */
     public int getFlashcardSetID() {
         return flashcardSetID;
     }
 
+    /**
+     * Sets the flashcard set ID
+     * @param flashcardSetID the flashcard set ID
+     */
     public void setFlashcardSetID(int flashcardSetID) {
         this.flashcardSetID = flashcardSetID;
     }

src/test/java/quiz_use_case/QuizUseCaseTest.java

@@ -6,6 +6,7 @@
 
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.List;
 
 /**
  * This class contains various test cases for the quiz use case.
@@ -58,16 +59,16 @@ void testOnlyMultipleChoice() throws IOException {
         QuizSettingsResponseModel quizSettingsResponseModel = controller.startQuiz(quizSettingsRequestModel);
         assertFalse(quizSettingsResponseModel.isFailed());
 
-        ArrayList<String> types = quizSettingsResponseModel.getTypes();
-        ArrayList<ArrayList<String>> outputText = quizSettingsResponseModel.getOutputText();
+        List<String> types = quizSettingsResponseModel.getTypes();
+        List<List<String>> outputText = quizSettingsResponseModel.getOutputText();
 
         assertEquals(10, types.size());
         assertEquals(10, outputText.size());
         assertTrue(types.contains("MC"));
         assertFalse(types.contains("TE"));
         assertFalse(types.contains("TF"));
 
-        ArrayList<String> userAnswers = new ArrayList<>();
+        List<String> userAnswers = new ArrayList<>();
         for (int i = 0; i < 10; i++) {
             userAnswers.add("incorrect answer");
         }
@@ -92,14 +93,14 @@ void testAllOptionsEnabled() throws IOException {
         QuizSettingsResponseModel quizSettingsResponseModel = controller.startQuiz(quizSettingsRequestModel);
         assertFalse(quizSettingsResponseModel.isFailed());
 
-        ArrayList<String> types = quizSettingsResponseModel.getTypes();
-        ArrayList<ArrayList<String>> outputText = quizSettingsResponseModel.getOutputText();
+        List<String> types = quizSettingsResponseModel.getTypes();
+        List<List<String>> outputText = quizSettingsResponseModel.getOutputText();
 
         assertEquals(12, types.size());
         assertEquals(12, outputText.size());
         assertTrue(types.contains("MC") || types.contains("TE") || types.contains("TF"));
 
-        ArrayList<String> userAnswers = new ArrayList<>();
+        List<String> userAnswers = new ArrayList<>();
         for (int i = 0; i < 12; i++) {
             userAnswers.add("incorrect answer");
         }