Package com.amalgamasimulation.studies.headlessapp.dto

Record Class ProgressItem

java.lang.Object
java.lang.Record
com.amalgamasimulation.studies.headlessapp.dto.ProgressItem
public record ProgressItem(ShortId runId, double completedFraction, Run.Status status, boolean cancelledBeforeStart) extends Record
A task execution status reported by a console application to Amalgama Cloud Runner.

completedFraction denotes the simulation progress, where 0.0 means 0 % complete, and 1.0 means 100 % complete.
When the status is NOT_STARTED, the completedFraction is 0.0.
After the status changes to IN_PROGRESS, the completedFraction starts to grow.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProgressItem(ShortId runId, double completedFraction, Run.Status status, boolean cancelledBeforeStart)
    Creates an instance of a ProgressItem record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    cancelledBeforeStart()
    Returns the value of the cancelledBeforeStart record component.
    double
    completedFraction()
    Returns the value of the completedFraction record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    ShortId
    runId()
    Returns the value of the runId record component.
    Run.Status
    status()
    Returns the value of the status 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

    • ProgressItem

      public ProgressItem(ShortId runId, double completedFraction, Run.Status status, boolean cancelledBeforeStart)
      Creates an instance of a ProgressItem record class.
      Parameters:
      runId - the value for the runId record component
      completedFraction - the value for the completedFraction record component
      status - the value for the status record component
      cancelledBeforeStart - the value for the cancelledBeforeStart 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 '=='.
      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.

    • runId

      public ShortId runId()
      Returns the value of the runId record component.
      Returns:
      the value of the runId record component

    • completedFraction

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

    • status

      public Run.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • cancelledBeforeStart

      public boolean cancelledBeforeStart()
      Returns the value of the cancelledBeforeStart record component.
      Returns:
      the value of the cancelledBeforeStart record component