Record Class ProgressSummary

java.lang.Object
java.lang.Record
io.nosqlbench.engine.api.activityapi.core.progress.ProgressSummary
public record ProgressSummary(String name, double pending, double current, double complete) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProgressSummary(String name, double pending, double current, double complete)
    Creates an instance of a ProgressSummary record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    complete()
    Returns the value of the complete record component.
    double
    current()
    Returns the value of the current 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.
    String
    name()
    Returns the value of the name record component.
    double
    pending()
    Returns the value of the pending record component.
    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

    • ProgressSummary

      public ProgressSummary(String name, double pending, double current, double complete)
      Creates an instance of a ProgressSummary record class.
      Parameters:
      name - the value for the name record component
      pending - the value for the pending record component
      current - the value for the current record component
      complete - the value for the complete record component

  • Method Details

    • toString

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

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • pending

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

    • current

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

    • complete

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