Merge pull request #2782 from Windchild292/dev_Windchild_Loan

Finances: Loan Refactoring/Standardization
MegaMek · Aug 6, 2021 · d90684b · d90684b
2 parents 61ef12e + 72d54ff
commit d90684b
Show file tree

Hide file tree

Showing 7 changed files with 364 additions and 376 deletions.
diff --git a/MekHQ/src/mekhq/campaign/Campaign.java b/MekHQ/src/mekhq/campaign/Campaign.java
@@ -6196,27 +6196,27 @@ public PartInventory getPartInventory(Part part) {
     }
 
     public void addLoan(Loan loan) {
-        addReport("You have taken out loan " + loan.getDescription()
+        addReport("You have taken out loan " + loan
                 + ". Your account has been credited "
                 + loan.getPrincipal().toAmountAndSymbolString()
                 + " for the principal amount.");
         finances.addLoan(loan);
         MekHQ.triggerEvent(new LoanNewEvent(loan));
         finances.credit(loan.getPrincipal(), Transaction.C_LOAN_PRINCIPAL,
-                "loan principal for " + loan.getDescription(), getLocalDate());
+                "loan principal for " + loan, getLocalDate());
     }
 
     public void payOffLoan(Loan loan) {
-        if (finances.debit(loan.getRemainingValue(),
-                Transaction.C_LOAN_PAYMENT, "loan payoff for " + loan.getDescription(), getLocalDate())) {
+        if (finances.debit(loan.determineRemainingValue(),
+                Transaction.C_LOAN_PAYMENT, "loan payoff for " + loan, getLocalDate())) {
             addReport("You have paid off the remaining loan balance of "
-                    + loan.getRemainingValue().toAmountAndSymbolString()
-                    + "on " + loan.getDescription());
+                    + loan.determineRemainingValue().toAmountAndSymbolString()
+                    + "on " + loan);
             finances.removeLoan(loan);
             MekHQ.triggerEvent(new LoanPaidEvent(loan));
         } else {
             addReport("<font color='red'>You do not have enough funds to pay off "
-                    + loan.getDescription() + "</font>");
+                    + loan + "</font>");
         }
 
     }

diff --git a/MekHQ/src/mekhq/campaign/finances/Finances.java b/MekHQ/src/mekhq/campaign/finances/Finances.java
@@ -101,7 +101,7 @@ public Money getBalance() {
 
     public Money getLoanBalance() {
         Money balance = Money.zero();
-        return balance.plus(loans.stream().map(Loan::getRemainingValue).collect(Collectors.toList()));
+        return balance.plus(loans.stream().map(Loan::determineRemainingValue).collect(Collectors.toList()));
     }
 
     public boolean isInDebt() {
@@ -186,8 +186,8 @@ public void writeToXml(PrintWriter pw1, int indent) {
         for (Transaction transaction : getAllTransactions()) {
             transaction.writeToXML(pw1, indent + 1);
         }
-        for (Loan loan : getAllLoans()) {
-            loan.writeToXml(pw1, indent + 1);
+        for (final Loan loan : getAllLoans()) {
+            loan.writeToXML(pw1, indent + 1);
         }
         for (Asset asset : getAllAssets()) {
             asset.writeToXML(pw1, indent + 1);
@@ -362,12 +362,11 @@ public void newDay(Campaign campaign) {
         for (Loan loan : loans) {
             if (loan.checkLoanPayment(campaign.getLocalDate())) {
                 if (debit(loan.getPaymentAmount(), Transaction.C_LOAN_PAYMENT,
-                        String.format(resourceMap.getString("Loan.title"), loan.getDescription()),
+                        String.format(resourceMap.getString("Loan.title"), loan),
                         campaign.getLocalDate())) {
                     campaign.addReport(String.format(
                             resourceMap.getString("Loan.text"),
-                            loan.getPaymentAmount().toAmountAndSymbolString(),
-                            loan.getDescription()));
+                            loan.getPaymentAmount().toAmountAndSymbolString(), loan));
                     loan.paidLoan();
                 } else {
                     campaign.addReport(String.format(
@@ -379,7 +378,7 @@ public void newDay(Campaign campaign) {
             if (loan.getRemainingPayments() > 0) {
                 newLoans.add(loan);
             } else {
-                campaign.addReport(String.format(resourceMap.getString("Loan.paid"), loan.getDescription()));
+                campaign.addReport(String.format(resourceMap.getString("Loan.paid"), loan));
             }
         }
         if ((wentIntoDebt != null) && !isInDebt()) {
@@ -428,12 +427,11 @@ public Money checkOverdueLoanPayments(Campaign campaign) {
         for (Loan loan : loans) {
             if (loan.isOverdue()) {
                 if (debit(loan.getPaymentAmount(), Transaction.C_LOAN_PAYMENT,
-                        String.format(resourceMap.getString("Loan.title"), loan.getDescription()),
+                        String.format(resourceMap.getString("Loan.title"), loan),
                         campaign.getLocalDate())) {
                     campaign.addReport(String.format(
                             resourceMap.getString("Loan.text"),
-                            loan.getPaymentAmount().toAmountAndSymbolString(),
-                            loan.getDescription()));
+                            loan.getPaymentAmount().toAmountAndSymbolString(), loan));
                     loan.paidLoan();
                 } else {
                     overdueAmount = overdueAmount.plus(loan.getPaymentAmount());
@@ -442,7 +440,7 @@ public Money checkOverdueLoanPayments(Campaign campaign) {
             if (loan.getRemainingPayments() > 0) {
                 newLoans.add(loan);
             } else {
-                campaign.addReport(String.format(resourceMap.getString("Loan.paid"), loan.getDescription()));
+                campaign.addReport(String.format(resourceMap.getString("Loan.paid"), loan));
             }
         }
         loans = newLoans;
@@ -478,7 +476,7 @@ public int getFailedCollateral() {
 
     public Money getTotalLoanCollateral() {
         Money amount = Money.zero();
-        return amount.plus(loans.stream().map(Loan::getCollateralAmount).collect(Collectors.toList()));
+        return amount.plus(loans.stream().map(Loan::determineCollateralAmount).collect(Collectors.toList()));
     }
 
     public Money getTotalAssetValue() {