Record Class RateLimiter.RateLimiterStats

java.lang.Object
java.lang.Record
com.loomcache.server.ratelimit.RateLimiter.RateLimiterStats
Enclosing class:
RateLimiter
public static record RateLimiter.RateLimiterStats(long totalAllowed, long totalDenied, double currentRate, long availablePermits, long timestamp) extends Record
Statistics record for rate limiter metrics.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RateLimiterStats(long totalAllowed, long totalDenied, double currentRate, long availablePermits, long timestamp)
    Creates an instance of a RateLimiterStats record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    availablePermits()
    Returns the value of the availablePermits record component.
    double
    currentRate()
    Returns the value of the currentRate 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.
    long
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalAllowed()
    Returns the value of the totalAllowed record component.
    long
    totalDenied()
    Returns the value of the totalDenied record component.

    Methods inherited from class Object

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

  • Constructor Details

    • RateLimiterStats

      public RateLimiterStats(long totalAllowed, long totalDenied, double currentRate, long availablePermits, long timestamp)
      Creates an instance of a RateLimiterStats record class.
      Parameters:
      totalAllowed - the value for the totalAllowed record component
      totalDenied - the value for the totalDenied record component
      currentRate - the value for the currentRate record component
      availablePermits - the value for the availablePermits record component
      timestamp - the value for the timestamp 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. 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.

    • totalAllowed

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

    • totalDenied

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

    • currentRate

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

    • availablePermits

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

    • timestamp

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