Record Class CooldownType

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.server.cooldown.CooldownType
Record Components:
id - The unique namespace identifier for the cooldown.
defaultDuration - The standard length of the cooldown.
defaultUnit - The time unit scaling the duration.
defaultPolicy - The policy defining how the cooldown behaves across sessions or resets.
public record CooldownType(net.kyori.adventure.key.Key id, long defaultDuration, TimeUnit defaultUnit, CooldownPolicy defaultPolicy) extends Record
Defines a structured cooldown configuration, representing its identifier, standard duration, unit of measurement, and behavioral enforcement policy.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Codec<CooldownType>
    CODEC
    The codec responsible for serializing and deserializing cooldown types securely natively.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CooldownType(net.kyori.adventure.key.Key id, long defaultDuration, TimeUnit defaultUnit)
    Constructs a standard cooldown configuration utilizing the default keeping policy.
    CooldownType(net.kyori.adventure.key.Key id, long defaultDuration, TimeUnit defaultUnit, CooldownPolicy defaultPolicy)
    Creates an instance of a CooldownType record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    defaultDuration()
    Returns the value of the defaultDuration record component.
    CooldownPolicy
    defaultPolicy()
    Returns the value of the defaultPolicy record component.
    TimeUnit
    defaultUnit()
    Returns the value of the defaultUnit 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.
    net.kyori.adventure.key.Key
    id()
    Returns the value of the id record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • CODEC

      public static final Codec<CooldownType> CODEC
      The codec responsible for serializing and deserializing cooldown types securely natively.

  • Constructor Details

    • CooldownType

      public CooldownType(net.kyori.adventure.key.Key id, long defaultDuration, TimeUnit defaultUnit)
      Constructs a standard cooldown configuration utilizing the default keeping policy.
      Parameters:
      id - The unique namespace identifier.
      defaultDuration - The length of the cooldown.
      defaultUnit - The associated time unit.

    • CooldownType

      public CooldownType(net.kyori.adventure.key.Key id, long defaultDuration, TimeUnit defaultUnit, CooldownPolicy defaultPolicy)
      Creates an instance of a CooldownType record class.
      Parameters:
      id - the value for the id record component
      defaultDuration - the value for the defaultDuration record component
      defaultUnit - the value for the defaultUnit record component
      defaultPolicy - the value for the defaultPolicy 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 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.

    • id

      public net.kyori.adventure.key.Key id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • defaultDuration

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

    • defaultUnit

      public TimeUnit defaultUnit()
      Returns the value of the defaultUnit record component.
      Returns:
      the value of the defaultUnit record component

    • defaultPolicy

      public CooldownPolicy defaultPolicy()
      Returns the value of the defaultPolicy record component.
      Returns:
      the value of the defaultPolicy record component