chore: spotless apply + adds java documentation

Author: AmiyahJo

lesson_17/bank/bank_app/src/main/java/com/codedifferently/lesson17/bank/AuditLog.java

@@ -3,13 +3,23 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/** Records and prints transaction logs. */
 public class AuditLog {
   private final List<String> logEntries;
 
+  /** Creates a new, empty audit log. */
   public AuditLog() {
     logEntries = new ArrayList<>();
   }
 
+  /**
+   * Adds a transaction entry to the log and prints it.
+   *
+   * @param accountNumber The account number involved.
+   * @param message A message describing the transaction.
+   * @param amount The amount of money in the transaction.
+   * @param type The type of transaction (e.g., Deposit, Withdrawal).
+   */
   public void logTransaction(String accountNumber, String message, double amount, String type) {
     String logEntry =
         String.format(
@@ -19,6 +29,11 @@ public void logTransaction(String accountNumber, String message, double amount,
     System.out.println(logEntry);
   }
 
+  /**
+   * Returns all the transaction logs.
+   *
+   * @return A list of all log entries.
+   */
   public List<String> getLogEntries() {
     return logEntries;
   }

lesson_17/bank/bank_app/src/main/java/com/codedifferently/lesson17/bank/BankAtm.java

@@ -14,9 +14,12 @@ public class BankAtm {
   private final AuditLog auditLog = new AuditLog();
 
   /**
-   * Adds a checking account to the bank.
+   * Adds a checking account to the bank. If the account is a BusinessCheckingAccount, it ensures
+   * that at least one of the account owners is a business.
    *
    * @param account The account to add.
+   * @throws IllegalArgumentException if the account is a BusinessCheckingAccount and none of its
+   *     owners are business.
    */
   public void addAccount(CheckingAccount account) {
     if (account instanceof BusinessCheckingAccount) {

lesson_17/bank/bank_app/src/main/java/com/codedifferently/lesson17/bank/MoneyOrder.java

@@ -1,10 +1,19 @@
 package com.codedifferently.lesson17.bank;
 
+/** Represents a Money Order transaction. */
 public class MoneyOrder {
   private final CheckingAccount sourceAccount;
   private final double amount;
   private AuditLog auditLog;
 
+  /**
+   * Creates a new money order transaction by withdrawing the specified amount from the source
+   * account. The transaction is logged for auditing purposes.
+   *
+   * @param sourceAccount The account from which funds will be withdrawn.
+   * @param amount The amount to withdraw and transfer in the money order.
+   * @param auditLog The audit log used to record the transaction details.
+   */
   public MoneyOrder(CheckingAccount sourceAccount, double amount, AuditLog auditLog) {
     this.sourceAccount = sourceAccount;
     this.amount = amount;
@@ -16,10 +25,20 @@ public MoneyOrder(CheckingAccount sourceAccount, double amount, AuditLog auditLo
         sourceAccount.getAccountNumber(), "MoneyOrder created", -amount, "MoneyOrder");
   }
 
+  /**
+   * Gets the source account from which the money was withdrawn.
+   *
+   * @return The source checking account.
+   */
   public CheckingAccount getSourceAccount() {
     return sourceAccount;
   }
 
+  /**
+   * Gets the amount of money involved in the Money Order transaction.
+   *
+   * @return The amount of the money order.
+   */
   public double getAmount() {
     return amount;
   }

lesson_17/bank/bank_app/src/main/java/com/codedifferently/lesson17/bank/SavingsAccount.java

@@ -3,21 +3,47 @@
 import com.codedifferently.lesson17.bank.exceptions.CheckNotAllowedException;
 import java.util.Set;
 
+/** Represents a savings account. */
 public class SavingsAccount extends CheckingAccount {
+
+  /**
+   * Creates a new savings account.
+   *
+   * @param accountNumber The account number.
+   * @param owners The owners of the account.
+   * @param initialBalance The initial balance of the account. If it's negative, it will be set to
+   *     zero.
+   */
   public SavingsAccount(String accountNumber, Set<Customer> owners, double initialBalance) {
     super(accountNumber, owners, Math.max(initialBalance, 0));
   }
 
+  /**
+   * Deposits funds into the savings account.
+   *
+   * @param amount The amount to deposit.
+   */
   @Override
   public void deposit(double amount) {
     super.deposit(amount);
   }
 
+  /**
+   * Withdraws funds from the savings account.
+   *
+   * @param amount The amount to withdraw.
+   */
   @Override
   public void withdraw(double amount) {
     super.withdraw(amount);
   }
 
+  /**
+   * Throws an exception because savings accounts cannot write checks.
+   *
+   * @param amount The amount to write a check for.
+   * @throws CheckNotAllowedException if attempting to write a check.
+   */
   public void writeCheck(double amount) {
     throw new CheckNotAllowedException("Savings account cannot write checks");
   }