Package org.jenkinsci.plugins.additionalmetrics

Record Class Duration

java.lang.Object
java.lang.Record
org.jenkinsci.plugins.additionalmetrics.Duration
public record Duration(long milliseconds) extends Record
Represents a time duration in milliseconds. Provides methods to access the duration as a long value or as a human-readable string.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Duration(long milliseconds)
    Creates an instance of a Duration record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    getAsLong()
    Returns the duration in milliseconds.
    String
    getAsString()
    Returns the duration as a human-readable time span string.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    milliseconds()
    Returns the value of the milliseconds 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

    • Duration

      public Duration(long milliseconds)
      Creates an instance of a Duration record class.
      Parameters:
      milliseconds - the value for the milliseconds record component

  • Method Details

    • getAsLong

      public long getAsLong()
      Returns the duration in milliseconds.
      Returns:
      the duration value in milliseconds

    • getAsString

      public String getAsString()
      Returns the duration as a human-readable time span string. Uses Jenkins' utility method to format the duration (e.g., "2 hr 30 min").
      Returns:
      the duration formatted as a human-readable string

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

    • milliseconds

      public long milliseconds()
      Returns the value of the milliseconds record component.
      Returns:
      the value of the milliseconds record component