Added Checkstyle to Player

src/main/java/Model/Player.java

@@ -1,96 +1,119 @@
 package Model;
+
 import java.math.BigDecimal;
 
+/**
+ * The player class is a description of the person player the game, 
+ * their starting point and their progress.
+ */
 public class Player {
-    private String name;
-    private BigDecimal startingMoney;
-    private BigDecimal money;
-    private Portfolio portfolio;
-    private TransactionArchive transactionArchive;
-
-    public Player(String name, BigDecimal startingMoney) {
-        if (name == null || name.isBlank()) {
-            throw new IllegalArgumentException("Player name cannot be null or blank");
-        }
-        if (startingMoney == null) {
-            throw new IllegalArgumentException("Starting money cannot be null");
-        }
-        if (startingMoney.compareTo(BigDecimal.ZERO) < 0) {
-            throw new IllegalArgumentException("Starting money cannot be negative");
-        }
+  private String name;
+  private BigDecimal startingMoney;
+  private BigDecimal money;
+  private Portfolio portfolio;
+  private TransactionArchive transactionArchive;
 
-        this.name = name;
-        this.startingMoney = startingMoney;
-        this.money = startingMoney;
-        this.portfolio = new Portfolio();
-        this.transactionArchive = new TransactionArchive();
+  /**
+   * Player method that includes the players name and the money they start with.
+   *
+   * @param name the name of the player
+   * @param startingMoney money the player starts with
+   */
+  public Player(String name, BigDecimal startingMoney) {
+    if (name == null || name.isBlank()) {
+      throw new IllegalArgumentException("Player name cannot be null or blank");
     }
-
-    public String getName() {
-        return this.name;
+    if (startingMoney == null) {
+      throw new IllegalArgumentException("Starting money cannot be null");
     }
-
-    public BigDecimal getMoney() {
-        return this.money;
+    if (startingMoney.compareTo(BigDecimal.ZERO) < 0) {
+      throw new IllegalArgumentException("Starting money cannot be negative");
     }
 
-    public void addMoney(BigDecimal amount) {
-        if (amount == null) {
-            throw new IllegalArgumentException("Amount cannot be null");
-        }
-        if (amount.compareTo(BigDecimal.ZERO) < 0) {
-            throw new IllegalArgumentException("Amount to add cannot be negative");
-        }
-        this.money = this.money.add(amount);
-    }
+    this.name = name;        
+    this.startingMoney = startingMoney;
+    this.money = startingMoney;
+    this.portfolio = new Portfolio();
+    this.transactionArchive = new TransactionArchive();
+  }
 
-    public void withdrawMoney(BigDecimal amount) {
-        if (amount == null) {
-            throw new IllegalArgumentException("Amount cannot be null");
-        }
-        if (amount.compareTo(BigDecimal.ZERO) < 0) {
-            throw new IllegalArgumentException("Amount to withdraw cannot be negative");
-        }
-        this.money = this.money.subtract(amount);
-    }
+  public String getName() {
+    return this.name;
+  }
 
-    public Portfolio getPortfolio() {
-        return this.portfolio;
+  public BigDecimal getMoney() {
+    return this.money;
+  }
+
+  /**
+   * Amount of money added.
+   *
+   * @param amount amount of money
+   */
+  public void addMoney(BigDecimal amount) {
+    if (amount == null) {
+      throw new IllegalArgumentException("Amount cannot be null");
+    }
+    if (amount.compareTo(BigDecimal.ZERO) < 0) {
+      throw new IllegalArgumentException("Amount to add cannot be negative");
     }
+    this.money = this.money.add(amount);
+  }
 
-    public TransactionArchive getTransactionArchive() {
-        return this.transactionArchive;
+  /**
+   * Amount of money withdrawn.
+   *
+   * @param amount amount of money
+   */
+  public void withdrawMoney(BigDecimal amount) {
+    if (amount == null) {
+      throw new IllegalArgumentException("Amount cannot be null");
     }
+    if (amount.compareTo(BigDecimal.ZERO) < 0) {
+      throw new IllegalArgumentException("Amount to withdraw cannot be negative");
+    }
+    this.money = this.money.subtract(amount);
+  }
 
-    /**
-     * Returns the player's current status based on trading activity and net worth performance.
-     * 
-     * Status levels:
-     * - NOVICE: Starting level, no requirements
-     * - INVESTOR: At least 10 weeks of trading AND net worth increased by at least 20%
-     * - SPECULATOR: At least 20 weeks of trading AND net worth at least doubled
-     * 
-     * @return the player's current PlayerStatus
-     */
-    public PlayerStatus getStatus() {
-        // Calculate total net worth: current cash + portfolio value
-        BigDecimal totalNetWorth = this.money.add(this.portfolio.getNetWorth());
-
-        // Get number of weeks with trading activity
-        int weeksActive = this.transactionArchive.countDistinctWeeks();
+  public Portfolio getPortfolio() {
+    return this.portfolio;
+  }
+
+  public TransactionArchive getTransactionArchive() {
+    return this.transactionArchive;
+  }
+
+
+  /**
+  * Returns the player's current status based on trading activity and net worth performance.   
+  * Status levels:
+  * - NOVICE: Starting level, no requirements
+  * - INVESTOR: At least 10 weeks of trading AND net worth increased by at least 20%
+  * - SPECULATOR: At least 20 weeks of trading AND net worth at least doubled
+  *
+  * @return the player's current PlayerStatus
+  */
+  public PlayerStatus getStatus() {
+    // Calculate total net worth: current cash + portfolio value
+    BigDecimal totalNetWorth = this.money.add(this.portfolio.getNetWorth());
 
-        // Check for SPECULATOR status: 20+ weeks AND net worth doubled
-        if (weeksActive >= 20 && totalNetWorth.compareTo(this.startingMoney.multiply(new BigDecimal("2"))) >= 0) {
-            return PlayerStatus.SPECULATOR;
-        }
+    // Get number of weeks with trading activity
+    int weeksActive = this.transactionArchive.countDistinctWeeks();
 
-        // Check for INVESTOR status: 10+ weeks AND net worth increased by 20%
-        if (weeksActive >= 10 && totalNetWorth.compareTo(this.startingMoney.multiply(new BigDecimal("1.2"))) >= 0) {
-            return PlayerStatus.INVESTOR;
-        }
+    // Check for SPECULATOR status: 20+ weeks AND net worth doubled
+    if (weeksActive >= 20 && totalNetWorth.compareTo(this
+        .startingMoney.multiply(new BigDecimal("2"))) >= 0) {
+      return PlayerStatus.SPECULATOR;
+    }
 
-        // Default: NOVICE
-        return PlayerStatus.NOVICE;
+    // Check for INVESTOR status: 10+ weeks AND net worth increased by 20%
+    if (weeksActive >= 10 && totalNetWorth.compareTo(this
+        .startingMoney.multiply(new BigDecimal("1.2"))) >= 0) {
+      return PlayerStatus.INVESTOR;
     }
+
+    // Default: NOVICE
+    return PlayerStatus.NOVICE;
+  }
 
 }