Record Class PositionCashFlowSummaryDTO

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.platform.models.api.dto.position.PositionCashFlowSummaryDTO
Record Components:
grossDividends - gross dividend income
taxWithheld - tax withheld from position income
fees - fees assigned to the position
netDividendIncome - dividend income after withholding tax
netCashFlow - net assigned position cash flow
public record PositionCashFlowSummaryDTO(double grossDividends, double taxWithheld, double fees, double netDividendIncome, double netCashFlow) extends Record
Summary of account cash transactions assigned to a position.
Version:
3.0.4
Author:
Stephen Prizio

  • Constructor Details

    • PositionCashFlowSummaryDTO

      public PositionCashFlowSummaryDTO(double grossDividends, double taxWithheld, double fees, double netDividendIncome, double netCashFlow)
      Creates an instance of a PositionCashFlowSummaryDTO record class.
      Parameters:
      grossDividends - the value for the grossDividends record component
      taxWithheld - the value for the taxWithheld record component
      fees - the value for the fees record component
      netDividendIncome - the value for the netDividendIncome record component
      netCashFlow - the value for the netCashFlow record component

  • Method Details

    • empty

      public static PositionCashFlowSummaryDTO empty()
      Creates an empty cash-flow summary.
      Returns:
      empty summary

    • 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.

    • grossDividends

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

    • taxWithheld

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

    • fees

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

    • netDividendIncome

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

    • netCashFlow

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