Chore: enhance Xbox class with cleaner comments and organization

Author: Dlafferty251

lesson_16/objects/objects_app/src/main/java/com/codedifferently/lesson16/dylans_xbox/Xbox.java

@@ -2,45 +2,16 @@
 
 import java.util.HashMap;
 
-/*
-   Create a sub-folder in the main app folder with a unique name for your work.
-     Design at least one custom class that represents a real-world object. //Object: Xbox HashMap
-       You must also incorporate an enum type as well.
-         Genre
-       The class must have at least one constructor.
-         I have this
-       The class must have at least 3 member functions.
-         I need this to be added maybe I can do addGame, removeGame, and getGame
-       One of your functions must make use of a conditional expression.
-         I can do this with the addGame method by implementing a check if the xbox has a disk drive && if the disk drive is empty
-
-       One of your functions must make use of your collection member variable.
-         I can do this with the getGame method by calling the games inside of the hashmap
-
-       One of your functions must make use of a loop.
-         I can do this with the removeGame method by using a for loop to iterate through the games and remove the game that matches the id passed in.
-       You must use at least one custom exception.
-
-         I can do this with the addGame method by creating a custom exception that checks if the disk drive is empty and throws an exception if it is not.
-       Create a matching subfolder in the test folder and a test file. Your test must include at least 5 test methods.
-         Tests:
-           1. testAddGame
-           2. testRemoveGame
-           3. testGetGame
-           4. testGetAllGames
-           5. testGetDiskDrive
-*/
 public class Xbox {
   private HashMap<Integer, String> games;
-  private XboxModel model; // Use the enum type here
+  // Declares the model of the Xbox by using the enum XboxModel
+  private XboxModel model;
   private String color;
   private int price;
-  private static final int MAX_GAMES = 10;
-  private boolean diskDrive; // Declares if there is a disk drive on the Xbox
-  private boolean diskDriveFull =
-      true; // If there is a disk drive, this will be t/f based on if there is a disk
-
-  // inside the xbox
+  // Declares if there is a disk drive on the Xbox
+  private boolean diskDrive;
+  // If there is a disk drive, this will be t/f based on if there is a disk inside of the xbox
+  private boolean diskDriveFull = true;
 
   // Defines a fixed set of constants for GameGenre
   public enum XboxModel {
@@ -52,6 +23,7 @@ public enum XboxModel {
     XBOXSERIESX
   }
 
+  // Constructor for the Xbox class
   public Xbox(String model, int price, String color, boolean diskDrive, boolean diskDriveFull) {
     this.model = XboxModel.valueOf(model.toUpperCase());
     this.price = price;
@@ -61,6 +33,7 @@ public Xbox(String model, int price, String color, boolean diskDrive, boolean di
     this.games = new HashMap<>();
   }
 
+  // Getters for the Xbox class
   public XboxModel getModel() {
     return model;
   }
@@ -85,19 +58,27 @@ public boolean DiskDriveFull() {
     return diskDriveFull;
   }
 
+  // Method that will add a game to the disk drive
+  // it will check if the disk drive is empty and if it is, it will add the game to the disk drive
+  // by turnign it to true.
   public void inputGame(int id, String name) throws Exception {
 
+    // These are my custom exceptions that will be thrown if the disk drive is empty or if the disk
+    // drive is full.
     if (!diskDrive) {
       throw new Exception("This Xbox does not have a disk drive. Cannot insert game.");
     }
     if (diskDriveFull) {
-      throw new Exception("Disk drive is full. Cannot insert game.");
+      throw new DiskDriveFullException("Disk drive is full. Cannot insert game.");
     }
+
     games.put(id, name);
     diskDriveFull = true;
     System.out.println("Game with ID: " + id + " was added to the disk drive.");
   }
 
+  // Method that will eject a game from the disk drive
+  // it will check if the game is in the drive and if it is, it will turn the drive to false.
   public void ejectGame(int id) {
     if (games.containsKey(id)) {
       games.remove(id);
@@ -108,12 +89,15 @@ public void ejectGame(int id) {
     }
   }
 
+  // This method will print all the games in the HashMap
+  // By running a for loop that will iterate through the games
   public void printAllGames() {
     for (Integer id : games.keySet()) {
       System.out.println("Game ID: " + id + ", Game Name: " + games.get(id));
     }
   }
 
+  // This method will remove a game from the HashMap
   public void setDiskDriveFull(boolean b) {
     this.diskDriveFull = b;
   }

lesson_16/objects/objects_app/src/test/java/XboxTest/XboxTest.java

@@ -1,16 +1,15 @@
 package XboxTest;
 
-import java.io.ByteArrayOutputStream;
-import java.io.PrintStream;
-import java.util.HashMap;
-
 import static org.junit.jupiter.api.Assertions.assertEquals; // Ensure LoadGame is imported
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
-import org.junit.jupiter.api.Test;
 
 import com.codedifferently.lesson16.dylans_xbox.LoadGame;
 import com.codedifferently.lesson16.dylans_xbox.Xbox;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.util.HashMap;
+import org.junit.jupiter.api.Test;
 
 public class XboxTest {
 
@@ -79,13 +78,10 @@ public void testPrintAllGames() {
     PrintStream originalOut = System.out;
     System.setOut(new PrintStream(outputStream));
 
-    // Act: Calls the printAllGames method
     xbox.printAllGames();
 
-    // Restore the original console output
     System.setOut(originalOut);
 
-    // Assert: Verify the captured output
     String expectedOutput =
         """
             Game ID: 1, Game Name: Call of Duty
@@ -119,25 +115,26 @@ public void testEjectGame() {
     xbox.ejectGame(1);
 
     // Assert: Verify the game was ejected (if needed, check the state of the Xbox object)
-    assertTrue(!xbox.getGames().containsKey(1), "Game with ID 1 should be removed from the games list.");
+    assertTrue(
+        !xbox.getGames().containsKey(1), "Game with ID 1 should be removed from the games list.");
   }
 
-  @Test 
+  @Test
   public void testGetGames() {
+
     Xbox xbox = new Xbox("XBOXSERIESX", 600, "Black", true, false);
     LoadGame loader =
         new LoadGame("src/main/java/com/codedifferently/lesson16/dylans_xbox/games.csv");
+
     try {
       loader.loadGamesFromFile(xbox);
     } catch (Exception e) {
       e.printStackTrace();
       fail("Exception occurred while loading games: " + e.getMessage());
     }
 
-    // Act: Get the games
     HashMap<Integer, String> games = xbox.getGames();
 
-    // Assert: Verify the games are loaded correctly
     assertEquals(10, games.size(), "There should be 10 games loaded.");
   }
 }