Record Class RuleDefinition

java.lang.Object
java.lang.Record
su.nightexpress.excellentclaims.api.rule.RuleDefinition
@NullMarked public record RuleDefinition(String name, List<String> description, su.nightexpress.nightcore.util.bukkit.NightItem icon) extends Record

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    RuleDefinition.Builder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    RuleDefinition(String name, List<String> description, su.nightexpress.nightcore.util.bukkit.NightItem icon)
    Creates an instance of a RuleDefinition record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RuleDefinition.Builder
    builder(String name)
     
    List<String>
    description()
    Returns the value of the description 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.
    su.nightexpress.nightcore.util.bukkit.NightItem
    icon()
    Returns the value of the icon record component.
    String
    name()
    Returns the value of the name 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

    • RuleDefinition

      public RuleDefinition(String name, List<String> description, su.nightexpress.nightcore.util.bukkit.NightItem icon)
      Creates an instance of a RuleDefinition record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      icon - the value for the icon record component

  • Method Details

    • builder

      public static RuleDefinition.Builder builder(String name)

    • 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 Objects::equals(Object,Object).
      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.

    • name

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

    • description

      public List<String> description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • icon

      public su.nightexpress.nightcore.util.bukkit.NightItem icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component