Record Class PaperTradingGateway.AccountSnapshot

java.lang.Object
java.lang.Record
com.quantfinlib.trading.PaperTradingGateway.AccountSnapshot
Enclosing class:
PaperTradingGateway
public static record PaperTradingGateway.AccountSnapshot(double cash, double equity, double realizedPnl, int rejectionCount, Map<String,Double> positions) extends Record
One internally consistent view of the whole account (single lock acquisition).

  • Constructor Summary

    Constructors
    Constructor
    Description
    AccountSnapshot(double cash, double equity, double realizedPnl, int rejectionCount, Map<String,Double> positions)
    Creates an instance of a AccountSnapshot record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    cash()
    Returns the value of the cash record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    equity()
    Returns the value of the equity record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    Map<String,Double>
    positions()
    Returns the value of the positions record component.
    double
    realizedPnl()
    Returns the value of the realizedPnl record component.
    int
    rejectionCount()
    Returns the value of the rejectionCount record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AccountSnapshot

      public AccountSnapshot(double cash, double equity, double realizedPnl, int rejectionCount, Map<String,Double> positions)
      Creates an instance of a AccountSnapshot record class.
      Parameters:
      cash - the value for the cash record component
      equity - the value for the equity record component
      realizedPnl - the value for the realizedPnl record component
      rejectionCount - the value for the rejectionCount record component
      positions - the value for the positions 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • cash

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

    • equity

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

    • realizedPnl

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

    • rejectionCount

      public int rejectionCount()
      Returns the value of the rejectionCount record component.
      Returns:
      the value of the rejectionCount record component

    • positions

      public Map<String,Double> positions()
      Returns the value of the positions record component.
      Returns:
      the value of the positions record component