Record Class Backtester.Segment

java.lang.Object
java.lang.Record
com.quantfinlib.backtest.Backtester.Segment
Enclosing class:
Backtester
public static record Backtester.Segment(BacktestResult result, Backtester.State endState) extends Record
A segment's result and the state it ended in.

  • Constructor Details

    • Segment

      public Segment(BacktestResult result, Backtester.State endState)
      Creates an instance of a Segment record class.
      Parameters:
      result - the value for the result record component
      endState - the value for the endState 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 Objects::equals(Object,Object).
      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.

    • result

      public BacktestResult result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component

    • endState

      public Backtester.State endState()
      Returns the value of the endState record component.
      Returns:
      the value of the endState record component