Package com.viaversion.viaversion.api.configuration

Record Class RateLimitConfig

java.lang.Object
java.lang.Record
com.viaversion.viaversion.api.configuration.RateLimitConfig
public record RateLimitConfig(boolean enabled, int maxRate, String maxRateKickMessage, int warningRate, int maxWarnings, long trackingPeriodNanos, String warningKickMessage, String ratePlaceholder) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    RateLimitConfig(boolean enabled, int maxRate, String maxRateKickMessage, int warningRate, int maxWarnings, long trackingPeriodNanos, String warningKickMessage, String ratePlaceholder)
    Creates an instance of a RateLimitConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    enabled()
    Returns the value of the enabled 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.
    int
    maxRate()
    Returns the value of the maxRate record component.
    String
    maxRateKickMessage()
    Returns the value of the maxRateKickMessage record component.
    int
    maxWarnings()
    Returns the value of the maxWarnings record component.
    String
    ratePlaceholder()
    Returns the value of the ratePlaceholder record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    trackingPeriodNanos()
    Returns the value of the trackingPeriodNanos record component.
    String
    warningKickMessage()
    Returns the value of the warningKickMessage record component.
    int
    warningRate()
    Returns the value of the warningRate record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RateLimitConfig

      public RateLimitConfig(boolean enabled, int maxRate, String maxRateKickMessage, int warningRate, int maxWarnings, long trackingPeriodNanos, String warningKickMessage, String ratePlaceholder)
      Creates an instance of a RateLimitConfig record class.
      Parameters:
      enabled - the value for the enabled record component
      maxRate - the value for the maxRate record component
      maxRateKickMessage - the value for the maxRateKickMessage record component
      warningRate - the value for the warningRate record component
      maxWarnings - the value for the maxWarnings record component
      trackingPeriodNanos - the value for the trackingPeriodNanos record component
      warningKickMessage - the value for the warningKickMessage record component
      ratePlaceholder - the value for the ratePlaceholder 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component

    • maxRate

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

    • maxRateKickMessage

      public String maxRateKickMessage()
      Returns the value of the maxRateKickMessage record component.
      Returns:
      the value of the maxRateKickMessage record component

    • warningRate

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

    • maxWarnings

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

    • trackingPeriodNanos

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

    • warningKickMessage

      public String warningKickMessage()
      Returns the value of the warningKickMessage record component.
      Returns:
      the value of the warningKickMessage record component

    • ratePlaceholder

      public String ratePlaceholder()
      Returns the value of the ratePlaceholder record component.
      Returns:
      the value of the ratePlaceholder record component