Package com.zetaplugins.zetacore.services.commands

Record Class RegisterableCommand

java.lang.Object
java.lang.Record
com.zetaplugins.zetacore.services.commands.RegisterableCommand
Record Components:
name - The name of the command
aliases - The aliases of the command
description - The description of the command
usage - The usage of the command
permission - The permission of the command
public record RegisterableCommand(String name, List<String> aliases, String description, String usage, String permission) extends Record
A command that can be registered

  • Constructor Details

    • RegisterableCommand

      public RegisterableCommand(String name, List<String> aliases, String description, String usage, String permission)
      Creates an instance of a RegisterableCommand record class.
      Parameters:
      name - the value for the name record component
      aliases - the value for the aliases record component
      description - the value for the description record component
      usage - the value for the usage record component
      permission - the value for the permission record component

  • Method Details

    • register

      public boolean register(JavaPlugin plugin, String commandNamespace, CommandMap commandMap, CommandExecutor executor, TabCompleter tabCompleter)
      Registers the command
      Parameters:
      plugin - The plugin instance
      commandNamespace - The command namespace
      commandMap - The command map
      executor - The command executor
      tabCompleter - The tab completer
      Returns:
      True if the command was registered successfully, false otherwise

    • fromAnnotation

      public static RegisterableCommand fromAnnotation(String name, AutoRegisterCommand annotation)
      Creates a RegisterableCommand from an AutoRegisterCommand annotation
      Parameters:
      name - The name of the command
      annotation - The AutoRegisterCommand annotation
      Returns:
      The RegisterableCommand

    • 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

    • aliases

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

    • description

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

    • usage

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

    • permission

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