Package de.cuioss.benchmarking.common.report

Record Class BenchmarkMetrics

java.lang.Object
java.lang.Record
de.cuioss.benchmarking.common.report.BenchmarkMetrics
public record BenchmarkMetrics(String throughputBenchmarkName, String latencyBenchmarkName, double throughput, double latency, double performanceScore, String performanceGrade) extends Record
Immutable record containing all computed benchmark metrics. This is the central data structure shared across all report generators.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BenchmarkMetrics(String throughputBenchmarkName, String latencyBenchmarkName, double throughput, double latency, double performanceScore, String performanceGrade)
    Creates an instance of a BenchmarkMetrics record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    double
    latency()
    Returns the value of the latency record component.
    String
    latencyBenchmarkName()
    Returns the value of the latencyBenchmarkName record component.
    String
    performanceGrade()
    Returns the value of the performanceGrade record component.
    double
    performanceScore()
    Returns the value of the performanceScore record component.
    double
    throughput()
    Returns the value of the throughput record component.
    String
    throughputBenchmarkName()
    Returns the value of the throughputBenchmarkName 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

    • BenchmarkMetrics

      public BenchmarkMetrics(String throughputBenchmarkName, String latencyBenchmarkName, double throughput, double latency, double performanceScore, String performanceGrade)
      Creates an instance of a BenchmarkMetrics record class.
      Parameters:
      throughputBenchmarkName - the value for the throughputBenchmarkName record component
      latencyBenchmarkName - the value for the latencyBenchmarkName record component
      throughput - the value for the throughput record component
      latency - the value for the latency record component
      performanceScore - the value for the performanceScore record component
      performanceGrade - the value for the performanceGrade 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.

    • throughputBenchmarkName

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

    • latencyBenchmarkName

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

    • throughput

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

    • latency

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

    • performanceScore

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

    • performanceGrade

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