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

Record Class UserNotAllowed

java.lang.Object
java.lang.Record
dev.sympho.modular_commands.api.command.result.UserNotAllowed
Record Components:
required - The group that the user must be a part of to run the command.
All Implemented Interfaces:
CommandFailure, CommandResult
public record UserNotAllowed(Group required) extends Record implements CommandFailure
A failure result due to the user not being part of a specific group.
Since:
1.0
Version:
1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserNotAllowed(Group required)
    Creates an instance of a UserNotAllowed record class.

  • Method Summary

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

    • UserNotAllowed

      public UserNotAllowed(Group required)
      Creates an instance of a UserNotAllowed record class.
      Parameters:
      required - the value for the required record component

  • Method Details

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

    • required

      public Group required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component