Record Class AccountLedgerSummary

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.platform.models.core.nonentities.account.AccountLedgerSummary
Record Components:
netProfit - closed position net profit
percentageReturn - net profit against funded capital
public record AccountLedgerSummary(double netProfit, double percentageReturn) extends Record
An account's ledger-derived figures, computed together.

These are always wanted as a pair, and computing them separately made the caller pay for the net profit twice, because the percentage return needs it too.

Version:
3.0.5
Author:
Stephen Prizio

  • Constructor Details

    • AccountLedgerSummary

      public AccountLedgerSummary(double netProfit, double percentageReturn)
      Creates an instance of a AccountLedgerSummary record class.
      Parameters:
      netProfit - the value for the netProfit record component
      percentageReturn - the value for the percentageReturn record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • netProfit

      public double netProfit()
      Returns the value of the netProfit record component.
      Returns:
      the value of the netProfit record component

    • percentageReturn

      public double percentageReturn()
      Returns the value of the percentageReturn record component.
      Returns:
      the value of the percentageReturn record component