Package io.github.mqzn.commands.base

Record Class CommandInfo

java.lang.Object
java.lang.Record
io.github.mqzn.commands.base.CommandInfo
public record CommandInfo(String permission, String description, String[] aliases) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CommandInfo
    EMPTY_INFO
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommandInfo(String permission, String description, String... aliases)
    Creates an instance of a CommandInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    aliases()
    Returns the value of the aliases record component.
    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.
    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 java.lang.Object

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

  • Field Details

    • EMPTY_INFO

      public static final CommandInfo EMPTY_INFO

  • Constructor Details

    • CommandInfo

      public CommandInfo(String permission, String description, String... aliases)
      Creates an instance of a CommandInfo record class.
      Parameters:
      permission - the value for the permission record component
      description - the value for the description record component
      aliases - the value for the aliases 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. 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.

    • permission

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

    • description

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

    • aliases

      public String[] aliases()
      Returns the value of the aliases record component.
      Returns:
      the value of the aliases record component