Record Class BrigadierHelper.CommandHelpMeta

java.lang.Object
java.lang.Record
com.soulfiremc.server.command.brigadier.BrigadierHelper.CommandHelpMeta
Enclosing class:
BrigadierHelper
public static record BrigadierHelper.CommandHelpMeta(@Nullable String help, boolean privateCommand) extends Record

  • Constructor Details

    • CommandHelpMeta

      public CommandHelpMeta(@Nullable String help, boolean privateCommand)
      Creates an instance of a CommandHelpMeta record class.
      Parameters:
      help - the value for the help record component
      privateCommand - the value for the privateCommand record component

  • Method Details

    • forPrivateCommand

      public static BrigadierHelper.CommandHelpMeta forPrivateCommand()

    • forPublicCommand

      public static BrigadierHelper.CommandHelpMeta forPublicCommand(String help)

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • help

      public @Nullable String help()
      Returns the value of the help record component.
      Returns:
      the value of the help record component

    • privateCommand

      public boolean privateCommand()
      Returns the value of the privateCommand record component.
      Returns:
      the value of the privateCommand record component