documentation

Author: anthony-chen-ca

src/main/java/quiz_use_case/GUI/FlatLabel.java

@@ -8,6 +8,11 @@
  * @author Anthony
  */
 public class FlatLabel extends JLabel {
+    /**
+     * Creates a FlatLaf styled label.
+     * @param text the display text
+     * @param type the style type. Refer to FlatLaf documentation for a list of style types.
+     */
     public FlatLabel(String text, String type) {
         super(text);
         this.putClientProperty("FlatLaf.styleClass", type);

src/main/java/quiz_use_case/GUI/MultipleChoiceQuestionCard.java

@@ -3,14 +3,15 @@
 import javax.swing.*;
 import java.awt.*;
 import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
 import java.util.ArrayList;
 
 /**
  * GUI panel that displays a multiple choice question.
  * Frameworks & Drivers
  * @author Anthony
  */
-public class MultipleChoiceQuestionCard extends QuestionCard {
+public class MultipleChoiceQuestionCard extends QuestionCard implements ActionListener {
     private final ArrayList<JRadioButton> choices;
 
     /**
@@ -99,6 +100,10 @@ public MultipleChoiceQuestionCard(int num, ArrayList<String> outputText, String
         }
     }
 
+    /**
+     * When a multiple choice button is pressed, this method sets the user answer according to its source button.
+     * @param e the action event
+     */
     @Override
     public void actionPerformed(ActionEvent e) {
         JRadioButton source = (JRadioButton) e.getSource();

src/main/java/quiz_use_case/GUI/QuestionCard.java

@@ -2,14 +2,13 @@
 
 import javax.swing.*;
 import java.awt.*;
-import java.awt.event.ActionListener;
 
 /**
  * Abstract class that represents a GUI panel that displays a quiz question.
  * Frameworks & Drivers
  * @author Anthony
  */
-public abstract class QuestionCard extends JPanel implements ActionListener {
+public abstract class QuestionCard extends JPanel {
     private String userAnswer = null;
 
     protected FlatLabel number;
@@ -46,11 +45,18 @@ public JLabel generateStatus(boolean isCorrect) {
         return new JLabel(statusMessage);
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the user answer.
+     * @return the user answer
+     */
     public String getUserAnswer() {
         return this.userAnswer;
     }
 
+    /**
+     * Sets the user answer.
+     * @param userAnswer the user answer
+     */
     public void setUserAnswer(String userAnswer) {
         this.userAnswer = userAnswer;
     }

src/main/java/quiz_use_case/GUI/Slider.java

@@ -12,7 +12,7 @@ public class Slider extends JPanel {
     public JSlider slider;
 
     private JLabel title;
-    private JLabel valueText;
+    private final JLabel valueText;
 
     /**
      * Constructs a slider.
@@ -47,28 +47,35 @@ public void updateValue() {
         this.valueText.setText(String.valueOf(this.slider.getValue()));
     }
 
+    /**
+     * Gets the slider's current value.
+     * @return the slider's value
+     */
     public int getValue() {
         return this.slider.getValue();
     }
 
+    /**
+     * Adds a change listener to the slider.
+     * @param listener the change listener
+     */
     public void addChangeListener(ChangeListener listener) {
         this.slider.addChangeListener(listener);
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the title.
+     * @return the title
+     */
     public JLabel getTitle() {
         return title;
     }
 
+    /**
+     * Sets the title.
+     * @param title the title
+     */
     public void setTitle(JLabel title) {
         this.title = title;
     }
-
-    public JLabel getValueText() {
-        return valueText;
-    }
-
-    public void setValueText(JLabel valueText) {
-        this.valueText = valueText;
-    }
 }

src/main/java/quiz_use_case/GUI/TextEntryQuestionCard.java

@@ -2,7 +2,6 @@
 
 import javax.swing.*;
 import java.awt.*;
-import java.awt.event.ActionEvent;
 import java.util.ArrayList;
 
 /**
@@ -108,9 +107,4 @@ public TextEntryQuestionCard(int num, ArrayList<String> outputText, String userA
     public void updateUserAnswer() {
         this.setUserAnswer(this.textArea.getText());
     }
-
-    @Override
-    public void actionPerformed(ActionEvent e) {
-
-    }
 }

src/main/java/quiz_use_case/GUI/TrueFalseQuestionCard.java

@@ -3,14 +3,15 @@
 import javax.swing.*;
 import java.awt.*;
 import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
 import java.util.ArrayList;
 
 /**
  * GUI panel that displays a true false question.
  * Frameworks & Drivers
  * @author Anthony
  */
-public class TrueFalseQuestionCard extends QuestionCard {
+public class TrueFalseQuestionCard extends QuestionCard implements ActionListener {
     private final JButton trueButton;
     private final JButton falseButton;
 
@@ -108,6 +109,10 @@ public TrueFalseQuestionCard(int num, ArrayList<String> outputText, String userA
         this.add(falseButton, c);
     }
 
+    /**
+     * If TRUE is toggled, toggle the true button. If FALSE is toggled, toggle the false button.
+     * @param e the action event
+     */
     @Override
     public void actionPerformed(ActionEvent e) {
         String c = e.getActionCommand();

src/main/java/quiz_use_case/QuizRequestModel.java

@@ -8,7 +8,7 @@
  * @author Anthony
  */
 public class QuizRequestModel {
-    private ArrayList<String> userAnswers;
+    private final ArrayList<String> userAnswers;
 
     /**
      * Constructs a quiz request model.
@@ -18,12 +18,11 @@ public QuizRequestModel(ArrayList<String> userAnswers) {
         this.userAnswers = userAnswers;
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the user answers.
+     * @return the user answers
+     */
     public ArrayList<String> getUserAnswers() {
         return userAnswers;
     }
-
-    public void setUserAnswers(ArrayList<String> userAnswers) {
-        this.userAnswers = userAnswers;
-    }
 }

src/main/java/quiz_use_case/screens/QuizSettingsScreen.java

@@ -39,7 +39,8 @@ private enum Actions {
     }
 
     /**
-     * Initializes the quiz settings screen.
+     * Initializes the quiz settings screen. If there are less than 4 flashcards with the given flashcard set ID, then
+     * just display an error pane.
      * @param controller the quiz settings controller
      * @param flashcardSetID the flashcard set ID
      */

src/test/java/quiz_use_case/QuizUseCaseTest.java

@@ -7,9 +7,23 @@
 import java.io.IOException;
 import java.util.ArrayList;
 
+/**
+ * This class contains various test cases for the quiz use case.
+ * @author Anthony
+ */
 public class QuizUseCaseTest {
     QuizController controller;
 
+    /**
+     * This method sets up my tests.
+     * @param numQuestions the number of questions
+     * @param timerOn is the timer on
+     * @param multipleChoiceOn is the multiple choice on
+     * @param textEntryOn is the text entry on
+     * @param trueFalseOn is the true false on
+     * @return the quiz settings request model
+     * @throws IOException if I can't access the test data
+     */
     QuizSettingsRequestModel setup(int numQuestions,
                                    boolean timerOn,
                                    boolean multipleChoiceOn,
@@ -32,6 +46,10 @@ QuizSettingsRequestModel setup(int numQuestions,
                 0, multipleChoiceOn, textEntryOn, trueFalseOn, 0);
     }
 
+    /**
+     * Tests the quiz use case when only multiple choice questions are enabled.
+     * @throws IOException if I can't access the test data
+     */
     @Test
     void testOnlyMultipleChoice() throws IOException {
         QuizSettingsRequestModel quizSettingsRequestModel = this.setup(10, false,
@@ -62,6 +80,10 @@ void testOnlyMultipleChoice() throws IOException {
         assertEquals(10, quizResponseModel.getNumQuestions());
     }
 
+    /**
+     * Tests the quiz use case when all question types are enabled.
+     * @throws IOException if I can't access the test data
+     */
     @Test
     void testAllOptionsEnabled() throws IOException {
         QuizSettingsRequestModel quizSettingsRequestModel = this.setup(12, false,
@@ -90,6 +112,10 @@ void testAllOptionsEnabled() throws IOException {
         assertEquals(12, quizResponseModel.getNumQuestions());
     }
 
+    /**
+     * Tests the quiz use case when no question types are enabled.
+     * @throws IOException if I can't access the test data
+     */
     @Test
     void testNoOptionsEnabled() throws IOException {
         QuizSettingsRequestModel quizSettingsRequestModel = this.setup(12, false,
@@ -99,6 +125,10 @@ void testNoOptionsEnabled() throws IOException {
         assertTrue(quizSettingsResponseModel.isFailed());
     }
 
+    /**
+     * Tests the quiz use case when the timer is set to a ridiculous value.
+     * @throws IOException if I can't access the test data
+     */
     @Test
     void testRidiculousTimer() throws IOException {
         QuizSettingsRequestModel quizSettingsRequestModel = this.setup(12, true,