Record Class RateLimiter.RateLimiterConfig

java.lang.Object
java.lang.Record
com.loomcache.server.ratelimit.RateLimiter.RateLimiterConfig
Enclosing class:
RateLimiter
public static record RateLimiter.RateLimiterConfig(double permitsPerSecond, int burstSize) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    RateLimiterConfig(double permitsPerSecond, int burstSize)
    Creates an instance of a RateLimiterConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    burstSize()
    Returns the value of the burstSize 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.
    static RateLimiter.RateLimiterConfig
    of(double rate)
     
    double
    permitsPerSecond()
    Returns the value of the permitsPerSecond record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • RateLimiterConfig

      public RateLimiterConfig(double permitsPerSecond, int burstSize)
      Creates an instance of a RateLimiterConfig record class.
      Parameters:
      permitsPerSecond - the value for the permitsPerSecond record component
      burstSize - the value for the burstSize record component

  • Method Details

    • permitsPerSecond

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

    • burstSize

      public int burstSize()
      Returns the value of the burstSize record component.
      Returns:
      the value of the burstSize record component

    • of

      public static RateLimiter.RateLimiterConfig of(double rate)

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