Merge pull request #82 from CSC207-2022F-UofT/5-feature-6-study-mode

completed javadoc

Author: anthony-chen-ca

src/main/java/study_mode_use_case/FlashcardStudierBuilder.java

@@ -16,8 +16,19 @@
  */
 public class FlashcardStudierBuilder {
 
+    /**
+     * a class that knows how to create a flashcard
+     */
     FlashcardFactory cardFactory = new FlashcardFactory();
+
+    /**
+     * a class that knows how to create a flashcard studier
+     */
     FlashcardStudierFactory studierFactory = new FlashcardStudierFactory();
+
+    /**
+     * an object which accesses the database
+     */
     DBGateway gateway;
 
     /**

src/main/java/study_mode_use_case/StudySessionController.java

@@ -7,17 +7,40 @@
  * @author Lucas Prates
  */
 public class StudySessionController {
+    /**
+     * an interactor which controls the use case
+     */
     private final StudySessionInputBoundary inputBoundary;
 
 
+    /**
+     * a string which tells the system that the user wants to flip the flashcard
+     */
     public static String flip = StudySessionInputBoundary.flip;
+
+    /**
+     * a string which tells the system that the user wants to gp to the next flashcard
+     */
     public static String next = StudySessionInputBoundary.next;
+
+    /**
+     * a string which tells the system that the user wants to gp to the previous flashcard
+     */
     public static String prev = StudySessionInputBoundary.prev;
 
+    /**
+     * a string which tells the system the user wants to shuffle randomly
+     */
     public static String shuffleSort = StudySessionInputBoundary.shuffleSort;
 
+    /**
+     * a string which tells the system the user wants to sort by alphabetical order
+     */
     public static String alphSort = StudySessionInputBoundary.alphSort;
 
+    /**
+     * a string which tells the system the user wants to sort by creation order
+     */
     public static String timeSort = StudySessionInputBoundary.timeSort;
 
     /**

src/main/java/study_mode_use_case/StudySessionInputBoundary.java

@@ -9,12 +9,34 @@
 
 public interface StudySessionInputBoundary {
 
+    /**
+     * a string which tells the system that the user wants to flip the flashcard
+     */
     String flip = "flip";
+
+    /**
+     * a string which tells the system that the user wants to gp to the next flashcard
+     */
     String next = "next";
+
+    /**
+     * a string which tells the system that the user wants to gp to the previous flashcard
+     */
     String prev = "prev";
 
+    /**
+     * a string which tells the system the user wants to shuffle randomly
+     */
     String shuffleSort = "shuffle";
+
+    /**
+     * a string which tells the system the user wants to sort by alphabetical order
+     */
     String alphSort = "alph";
+
+    /**
+     * a string which tells the system the user wants to sort by creation order
+     */
     String timeSort = "time";
 
     /**

src/main/java/study_mode_use_case/StudySessionInteractor.java

@@ -17,9 +17,20 @@
  */
 public class StudySessionInteractor implements StudySessionInputBoundary {
 
+    /**
+     * a Flashcard Set which can handle study mode operations (flipping, going to next flashcard,
+     * going to previous flashcard)
+     */
     private FlashcardStudier studier;
+
+    /**
+     * an object which can prepare data for the view
+     */
     private final StudySessionOutputBoundary presenter;
 
+    /**
+     * an object that knows how to build a flashcard studier
+     */
     private final FlashcardStudierBuilder builder;
 
     /**

src/main/java/study_mode_use_case/StudySessionRequestModel.java

@@ -8,6 +8,9 @@
  * @author Lucas Prates
  */
 public class StudySessionRequestModel {
+    /**
+     * a string which specifies what the user wants to do
+     */
     private String command;
 
     /**

src/main/java/study_mode_use_case/StudySessionResponseModel.java

@@ -8,7 +8,15 @@
  * @author Lucas Prates
  */
 public class StudySessionResponseModel {
+    /**
+     * the text to be displayed on the on-screen flashcard
+     */
     private final String outputText;
+
+    /**
+     * the position of the current flashcard in the flashcard set
+     * starting at 1
+     */
     private final int cardNumber;
 
     /**

src/main/java/study_mode_use_case/StudySettingsRequestModel.java

@@ -9,10 +9,24 @@
  * @author Lucas Prates
  */
 public class StudySettingsRequestModel {
+    /**
+     * the id of the flashcard set to be studied
+     */
     private final int flashcardSetId;
+
+    /**
+     * the user's desired sorting order
+     */
     private final String sortingOrder;
 
+    /**
+     * a boolean specifying if the flashcard set should be sorted in order or in reverse
+     */
     private boolean isReverse = false;
+
+    /**
+     * a boolean which specifies if the term or definition is displayed by default
+     */
     private final boolean termIsDefault;
 
     /**

src/main/java/study_mode_use_case/StudySettingsResponseModel.java

@@ -9,8 +9,17 @@
  */
 public class StudySettingsResponseModel extends StudySessionResponseModel {
 
+    /**
+     * stores the length of the flashcard set
+     */
     private final int numFlashcards;
+    /**
+     * stores the title of the flashcard set
+     */
     private final String title;
+    /**
+     * stores the id of the flashcard set
+     */
     private final int flashcardSetId;
 
     /**

src/main/java/study_mode_use_case/screens/StudySessionScreen.java

@@ -15,14 +15,31 @@
  * Frameworks & Drivers
  * @author Lucas Prates
  */
+
 public class StudySessionScreen extends Screen implements ActionListener {
+    /**
+     * the study session controller
+     */
     private final StudySessionController controller;
+
+    /**
+     * a JButton which handles flipping the flashcard
+     */
     private final JButton flip;
 
+    /**
+     * stores the length of the flashcard set
+     */
     private final int numFlashcards;
 
+    /**
+     * stores the text to be written to the on-screen flashcard
+     */
     private final JLabel cardLabel;
 
+    /**
+     * the id of the flashcard set being studied
+     */
     private final int flashcardSetId;
 
     /**

src/main/java/study_mode_use_case/screens/StudySettingsFailed.java

@@ -1,5 +1,8 @@
 package study_mode_use_case.screens;
 
+/**
+ * An exception which is called if the study mode interactor fails to run
+ */
 public class StudySettingsFailed extends RuntimeException {
     public StudySettingsFailed(String error) {
         super(error);