Package dev.kitteh.factions.permissible

Record Class PermissibleAction.Simple

java.lang.Object
java.lang.Record
dev.kitteh.factions.permissible.PermissibleAction.Simple
Record Components:
name - name
description - description
shortDescription - shortDescription
All Implemented Interfaces:
PermissibleAction
Enclosing interface:
PermissibleAction
public static record PermissibleAction.Simple(String name, String description, String shortDescription) extends Record implements PermissibleAction
Simple little record for your convenience.
See Also:

  • Constructor Details

    • Simple

      public Simple(String name, String description, String shortDescription)
      Creates an instance of a Simple record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      shortDescription - the value for the shortDescription record component

  • Method Details

    • prerequisite

      public @Nullable Upgrade prerequisite()
      Description copied from interface: PermissibleAction
      Prerequisite for this permissible action to appear to users, if present.
      Specified by:
      prerequisite in interface PermissibleAction
      Returns:
      prerequisite or null if not present

    • 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.
      Specified by:
      name in interface PermissibleAction
      Returns:
      the value of the name record component

    • description

      public String description()
      Returns the value of the description record component.
      Specified by:
      description in interface PermissibleAction
      Returns:
      the value of the description record component

    • shortDescription

      public String shortDescription()
      Returns the value of the shortDescription record component.
      Specified by:
      shortDescription in interface PermissibleAction
      Returns:
      the value of the shortDescription record component