Record Class WarmingProgress

java.lang.Object
java.lang.Record
com.loomcache.server.cache.WarmingProgress
public record WarmingProgress(long totalKeys, long loadedKeys, long failedKeys, long elapsedMs, long estimatedRemainingMs) extends Record
Real-time progress metrics during a cache warming operation. Tracks total keys, loaded keys, failed keys, elapsed time, and estimated remaining time.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WarmingProgress(long totalKeys, long loadedKeys, long failedKeys, long elapsedMs, long estimatedRemainingMs)
    Creates an instance of a WarmingProgress record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    elapsedMs()
    Returns the value of the elapsedMs record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    estimatedRemainingMs()
    Returns the value of the estimatedRemainingMs record component.
    long
    failedKeys()
    Returns the value of the failedKeys record component.
    double
    getKeysPerSecond()
    Get the throughput in keys per second.
    double
    getProgressPercentage()
    Calculate the percentage of keys loaded (0-100).
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isComplete()
    Check if warming is complete.
    long
    loadedKeys()
    Returns the value of the loadedKeys record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalKeys()
    Returns the value of the totalKeys record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • WarmingProgress

      public WarmingProgress(long totalKeys, long loadedKeys, long failedKeys, long elapsedMs, long estimatedRemainingMs)
      Creates an instance of a WarmingProgress record class.
      Parameters:
      totalKeys - the value for the totalKeys record component
      loadedKeys - the value for the loadedKeys record component
      failedKeys - the value for the failedKeys record component
      elapsedMs - the value for the elapsedMs record component
      estimatedRemainingMs - the value for the estimatedRemainingMs record component

  • Method Details

    • getProgressPercentage

      public double getProgressPercentage()
      Calculate the percentage of keys loaded (0-100).

    • getKeysPerSecond

      public double getKeysPerSecond()
      Get the throughput in keys per second.

    • isComplete

      public boolean isComplete()
      Check if warming is complete.

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

    • totalKeys

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

    • loadedKeys

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

    • failedKeys

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

    • elapsedMs

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

    • estimatedRemainingMs

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