timer is implemented. i need to work on documentation now

Author: anthony-chen-ca

src/main/java/entities/MultipleChoiceQuestion.java

@@ -10,14 +10,22 @@
  * @author Anthony
  */
 public class MultipleChoiceQuestion extends QuizQuestion {
+    /* If given term is true, then the term is the initial prompt.
+    If given term is false, then the definition is the initial prompt.
+     */
     private final boolean givenTerm;
 
     private String question;
-    private String[] choices;
+    private final String[] choices;
     private final int numChoices = 4;
 
     private static final Random rand = new Random();
 
+    /**
+     * Constructs a multiple choice question.
+     * @param flashcards the list of flashcards
+     * @param index the index of a specific flashcard
+     */
     public MultipleChoiceQuestion(List<Flashcard> flashcards, int index) {
         this.givenTerm = rand.nextBoolean();
         this.choices = new String[numChoices];
@@ -54,6 +62,10 @@ public void generateQuestion(List<Flashcard> flashcards, int index) {
         }
     }
 
+    /**
+     * Returns the string representation of the multiple choice question.
+     * @return string representation
+     */
     @Override
     public String toString() {
         StringBuilder s = new StringBuilder("Prompt: " + this.question + "\n");
@@ -63,15 +75,26 @@ public String toString() {
         return s.toString();
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the question.
+     * @return the question
+     */
     public String getQuestion() {
         return question;
     }
 
+    /**
+     * Sets the question.
+     * @param question the question
+     */
     public void setQuestion(String question) {
         this.question = question;
     }
 
+    /**
+     * Sets the choices.
+     * @return the choices
+     */
     public String[] getChoices() {
         return choices;
     }

src/main/java/entities/Quiz.java

@@ -16,7 +16,7 @@ public class Quiz {
 
     private int score;
 
-    private static final Random rand = new Random();
+    private static final Random rand = new Random(); // used for calculating random numbers
 
     /**
      * Precondition: flashcards contains at least 4 flashcards, and at least 1 question type is enabled in quizSettings.
@@ -72,7 +72,10 @@ public void evaluate() {
         }
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Sets the user answers.
+     * @param userAnswers the user answers
+     */
     public void setUserAnswers(List<String> userAnswers) {
         for (int i = 0; i < userAnswers.size(); i++) {
             QuizQuestion q = this.quizQuestions.get(i);
@@ -81,6 +84,10 @@ public void setUserAnswers(List<String> userAnswers) {
         }
     }
 
+    /**
+     * Gets the actual answers.
+     * @return the actual answers
+     */
     public List<String> getActualAnswers() {
         List<String> actualAnswers = new ArrayList<>();
         for (QuizQuestion q : this.quizQuestions) {
@@ -89,14 +96,26 @@ public List<String> getActualAnswers() {
         return actualAnswers;
     }
 
+    /**
+     * Gets the quiz questions.
+     * @return the quiz questions
+     */
     public List<QuizQuestion> getQuizQuestions() {
         return this.quizQuestions;
     }
 
+    /**
+     * Gets the quiz score.
+     * @return the score
+     */
     public int getScore() {
         return this.score;
     }
 
+    /**
+     * Gets the number of questions.
+     * @return the number of questions
+     */
     public int getNumQuestions() {
         return this.quizQuestions.size();
     }

src/main/java/entities/QuizQuestion.java

@@ -27,19 +27,22 @@ public boolean isCorrect(){
         return this.actualAnswer.equalsIgnoreCase(this.userAnswer);
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the actual answer.
+     * @return the actual answer
+     */
     public String getActualAnswer() {
         return actualAnswer;
     }
 
+    /**
+     * Sets the actual answer.
+     * @param actualAnswer the actual answer
+     */
     public void setActualAnswer(String actualAnswer) {
         this.actualAnswer = actualAnswer;
     }
 
-    public String getUserAnswer() {
-        return userAnswer;
-    }
-
     /**
      * Sets the user answer. If the user answer is null or empty, the user answer should be set to null.
      * @param userAnswer the user answer

src/main/java/entities/QuizSettings.java

@@ -5,12 +5,12 @@
  * @author Anthony
  */
 public class QuizSettings {
-    private int numQuestions;
-    private boolean timerOn;
-    private int timerDuration;
-    private boolean multipleChoiceOn;
-    private boolean textEntryOn;
-    private boolean trueFalseOn;
+    private final int numQuestions;
+    private final boolean timerOn;
+    private final int timerDuration;
+    private final boolean multipleChoiceOn;
+    private final boolean textEntryOn;
+    private final boolean trueFalseOn;
 
     /**
      * Constructor for quiz settings.
@@ -45,52 +45,35 @@ public boolean timerIsReasonable() {
         return ((1 <= this.timerDuration && this.timerDuration <= 60) || !(this.timerOn));
     }
 
-    /** 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;
-    }
-
-    public boolean isTimerOn() {
-        return timerOn;
-    }
-
-    public void setTimerOn(boolean timerOn) {
-        this.timerOn = timerOn;
-    }
-
-    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;
-    }
 }

src/main/java/entities/TextEntryQuestion.java

@@ -14,6 +14,11 @@ public class TextEntryQuestion extends QuizQuestion {
 
     private static final Random rand = new Random();
 
+    /**
+     * Constructs a text entry question.
+     * @param flashcards the list of flashcards
+     * @param index the index of a specific flashcard
+     */
     public TextEntryQuestion(List<Flashcard> flashcards, int index) {
         this.missingTerm = rand.nextBoolean();
         generateQuestion(flashcards, index);
@@ -36,6 +41,10 @@ public void generateQuestion(List<Flashcard> flashcards, int index) {
         }
     }
 
+    /**
+     * Returns the string representation of the text entry question.
+     * @return string representation
+     */
     @Override
     public String toString() {
         if (this.missingTerm) {
@@ -45,24 +54,35 @@ public String toString() {
         }
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the term.
+     * @return the term
+     */
     public String getTerm() {
         return term;
     }
 
+    /**
+     * Sets the term.
+     * @param term the term
+     */
     public void setTerm(String term) {
         this.term = term;
     }
 
+    /**
+     * Gets the definition.
+     * @return the definition.
+     */
     public String getDefinition() {
         return definition;
     }
 
+    /**
+     * Sets the definition.
+     * @param definition the definition
+     */
     public void setDefinition(String definition) {
         this.definition = definition;
     }
-
-    public boolean isMissingTerm() {
-        return missingTerm;
-    }
 }

src/main/java/entities/TrueFalseQuestion.java

@@ -14,6 +14,11 @@ public class TrueFalseQuestion extends QuizQuestion {
 
     private static final Random rand = new Random();
 
+    /**
+     * Constructs a true/false question.
+     * @param flashcards the list of flashcards
+     * @param index the index of a specific flashcard
+     */
     public TrueFalseQuestion(List<Flashcard> flashcards, int index) {
         this.pranked = rand.nextBoolean();
         generateQuestion(flashcards, index);
@@ -40,6 +45,10 @@ public void generateQuestion(List<Flashcard> flashcards, int index) {
         this.potentialDefinition = flashcard.getDefinition();
     }
 
+    /**
+     * Returns the string representation of the true/false question.
+     * @return string representation
+     */
     @Override
     public String toString() {
         return ("TRUE OR FALSE?\nTerm: " + this.term + "\nDefinition: " + this.potentialDefinition);
@@ -59,20 +68,27 @@ public static int randomExcluded(int max, int excluded) {
         return n;
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the term.
+     * @return the term
+     */
     public String getTerm() {
         return term;
     }
 
+    /**
+     * Sets the term.
+     * @param term the term
+     */
     public void setTerm(String term) {
         this.term = term;
     }
 
+    /**
+     * Gets the potential definition.
+     * @return the potential definition
+     */
     public String getPotentialDefinition() {
         return potentialDefinition;
     }
-
-    public void setPotentialDefinition(String potentialDefinition) {
-        this.potentialDefinition = potentialDefinition;
-    }
 }