Record Class CommandRegistry.CommandResult

java.lang.Object
java.lang.Record
fr.fidorial.command.CommandRegistry.CommandResult
Record Components:
returnValue - the raw brigadier return value from CommandDispatcher.execute(ParseResults). 0 is used both when the command failed to parse or execute, and when a command had no effect.
Enclosing interface:
CommandRegistry
public static record CommandRegistry.CommandResult(int returnValue) extends Record
The outcome of a command dispatch.
Since:
0.1.0
API Note:
Use executed() to distinguish outcome from raw value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommandResult(int returnValue)
    Creates an instance of a CommandResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    executed()
    Returns whether the dispatch had any effect.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    returnValue()
    Returns the value of the returnValue 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

    • CommandResult

      public CommandResult(int returnValue)
      Creates an instance of a CommandResult record class.
      Parameters:
      returnValue - the value for the returnValue record component

  • Method Details

    • executed

      public boolean executed()
      Returns whether the dispatch had any effect.
      Returns:
      true if returnValue() is at least Command.SINGLE_SUCCESS
      Since:
      0.1.0

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • returnValue

      public int returnValue()
      Returns the value of the returnValue record component.
      Returns:
      the value of the returnValue record component