Package com.qtsurfer.api.sdk

Record Class BacktestOutcome.Completed

java.lang.Object
java.lang.Record
com.qtsurfer.api.sdk.BacktestOutcome.Completed
Record Components:
state - the platform's job record, never null
results - the run's numbers
All Implemented Interfaces:
BacktestOutcome
Enclosing interface:
BacktestOutcome
public static record BacktestOutcome.Completed(com.qtsurfer.api.client.model.JobState state, com.qtsurfer.api.client.model.ResultMap results) extends Record implements BacktestOutcome
The run finished and produced its numbers. This is the only variant on which results() is a final account of the run.

  • Constructor Details

    • Completed

      public Completed(com.qtsurfer.api.client.model.JobState state, com.qtsurfer.api.client.model.ResultMap results)
      Creates an instance of a Completed record class.
      Parameters:
      state - the value for the state record component
      results - the value for the results record component

  • Method Details

    • finished

      public boolean finished()
      Returns true — the run finished.
      Specified by:
      finished in interface BacktestOutcome
      Returns:
      true — the run finished

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

    • state

      public com.qtsurfer.api.client.model.JobState state()
      Returns the value of the state record component.
      Specified by:
      state in interface BacktestOutcome
      Returns:
      the value of the state record component

    • results

      public com.qtsurfer.api.client.model.ResultMap results()
      Returns the value of the results record component.
      Specified by:
      results in interface BacktestOutcome
      Returns:
      the value of the results record component