Record Class Kit

java.lang.Object
java.lang.Record
fr.mathildeuh.youneedme.api.kits.Kit
public record Kit(String id, String displayName, List<org.bukkit.inventory.ItemStack> items, @Nullable String permission, long cooldownSeconds, boolean oneTime, @Nullable Integer maxClaims) extends Record
A kit definition. Kits are configuration, not player data (see modules/kits.yml), but still modeled here so expansions can register additional kits programmatically (a "new kit type", e.g. one generated from a template) without touching YAML.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Kit(String id, String displayName, List<org.bukkit.inventory.ItemStack> items, @Nullable String permission, long cooldownSeconds, boolean oneTime, @Nullable Integer maxClaims)
    Creates an instance of a Kit record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    cooldownSeconds()
    Returns the value of the cooldownSeconds record component.
    String
    displayName()
    Returns the value of the displayName record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    hasCooldown()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    id()
    Returns the value of the id record component.
    List<org.bukkit.inventory.ItemStack>
    items()
    Returns the value of the items record component.
    @Nullable Integer
    maxClaims()
    Returns the value of the maxClaims record component.
    boolean
    oneTime()
    Returns the value of the oneTime record component.
    @Nullable String
    permission()
    Returns the value of the permission 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

    • Kit

      public Kit(String id, String displayName, List<org.bukkit.inventory.ItemStack> items, @Nullable @Nullable String permission, long cooldownSeconds, boolean oneTime, @Nullable @Nullable Integer maxClaims)
      Creates an instance of a Kit record class.
      Parameters:
      id - the value for the id record component
      displayName - the value for the displayName record component
      items - the value for the items record component
      permission - the value for the permission record component
      cooldownSeconds - the value for the cooldownSeconds record component
      oneTime - the value for the oneTime record component
      maxClaims - the value for the maxClaims record component

  • Method Details

    • hasCooldown

      public boolean hasCooldown()

    • 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 String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • displayName

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

    • items

      public List<org.bukkit.inventory.ItemStack> items()
      Returns the value of the items record component.
      Returns:
      the value of the items record component

    • permission

      @Nullable public @Nullable String permission()
      Returns the value of the permission record component.
      Returns:
      the value of the permission record component

    • cooldownSeconds

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

    • oneTime

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

    • maxClaims

      @Nullable public @Nullable Integer maxClaims()
      Returns the value of the maxClaims record component.
      Returns:
      the value of the maxClaims record component