Package org.jenkinsci.plugins.additionalmetrics

Record Class Rate

java.lang.Object
java.lang.Record
org.jenkinsci.plugins.additionalmetrics.Rate
public record Rate(double rate) extends Record
Represents a rate as a double value between 0.0 and 1.0. Provides methods to access the rate as a double or as a formatted percentage string.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Rate(double rate)
    Creates an instance of a Rate record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    getAsDouble()
    Returns the rate as a double value.
    String
    getAsString()
    Returns the rate as a formatted percentage string.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    rate()
    Returns the value of the rate 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

    • Rate

      public Rate(double rate)
      Creates an instance of a Rate record class.
      Parameters:
      rate - the value for the rate record component

  • Method Details

    • getAsDouble

      public double getAsDouble()
      Returns the rate as a double value.
      Returns:
      the rate value as a double between 0.0 and 1.0

    • getAsString

      public String getAsString()
      Returns the rate as a formatted percentage string. The percentage is formatted to two decimal places with a "%" suffix.
      Returns:
      the rate formatted as a percentage string (e.g., "75.25%")

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

    • rate

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