Package dev.jorel.commandapi.wrappers

Record Class CommandResult

java.lang.Object
java.lang.Record
dev.jorel.commandapi.wrappers.CommandResult
public record CommandResult(org.bukkit.command.Command command, String[] args) extends Record
CommandResult represents an executable command. It contains the following methods:
  • command - the command which this CommandResult contains
  • args - the arguments that were provided to this command
  • execute(CommandSender) - Run the command using the given CommandSender directly

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommandResult(org.bukkit.command.Command command, String[] args)
    Creates an instance of a CommandResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    args()
    Returns the value of the args record component.
    org.bukkit.command.Command
    command()
    Returns the value of the command record component.
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    execute(org.bukkit.command.CommandSender sender)
    Executes this command with a provided CommandSender.
    int
    hashCode()
    Returns a hash code value for this object.
    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

  • Constructor Details

    • CommandResult

      public CommandResult(org.bukkit.command.Command command, String[] args)
      Creates an instance of a CommandResult record class.
      Parameters:
      command - the value for the command record component
      args - the value for the args record component

  • Method Details

    • execute

      public boolean execute(org.bukkit.command.CommandSender sender)
      Executes this command with a provided CommandSender. This is equivalent to running result.command().execute(sender, result.command().getLabel(), result.args());
      Parameters:
      sender - the command sender that will be used to execute this command

    • equals

      public 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.

    • hashCode

      public 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

    • toString

      public 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

    • command

      public org.bukkit.command.Command command()
      Returns the value of the command record component.
      Returns:
      the value of the command record component

    • args

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