Package dev.sympho.modular_commands.api.command.result

Record Class UserMissingPermissions

java.lang.Object
java.lang.Record
dev.sympho.modular_commands.api.command.result.UserMissingPermissions
Record Components:
missingDiscordPermissions - The built-in permissions that the user is missing but are required to run the command.
All Implemented Interfaces:
CommandFailure, CommandFailureMessage, CommandResult
public record UserMissingPermissions(discord4j.rest.util.PermissionSet missingDiscordPermissions) extends Record implements CommandFailureMessage
A failure result due to the user having insufficient permissions.
Since:
1.0
Version:
1.0

  • Constructor Details

    • UserMissingPermissions

      public UserMissingPermissions(discord4j.rest.util.PermissionSet missingDiscordPermissions)
      Creates an instance of a UserMissingPermissions record class.
      Parameters:
      missingDiscordPermissions - the value for the missingDiscordPermissions record component

  • Method Details

    • message

      public String message()
      Description copied from interface: CommandFailureMessage
      Retrieves the message to the user.
      Specified by:
      message in interface CommandFailureMessage
      Returns:
      The message to the user.

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

    • missingDiscordPermissions

      public discord4j.rest.util.PermissionSet missingDiscordPermissions()
      Returns the value of the missingDiscordPermissions record component.
      Returns:
      the value of the missingDiscordPermissions record component