Package net.kautler.command.api.restriction.javacord

Class UserJavacord

  • All Implemented Interfaces:
    Restriction<Message>
    public abstract class UserJavacord
extends Object
implements Restriction<Message>
    A restriction that allows a command for certain users and is evaluated by the Javacord command handler. To use it, create a trivial subclass of this class and make it a discoverable CDI bean, for example by annotating it with @ApplicationScoped.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected UserJavacord​(long userId)
      Constructs a new user restriction for checking the channel ID.
      protected UserJavacord​(String userName)
      Constructs a new user restriction for checking the user name case-sensitively against a fixed name.
      protected UserJavacord​(String userName, boolean caseSensitive)
      Constructs a new user restriction for checking the user name against a fixed name.
      protected UserJavacord​(Pattern userPattern)
      Constructs a new user restriction for checking the user name against a regular expression.

    • Constructor Detail

      • UserJavacord

        protected UserJavacord​(long userId)
        Constructs a new user restriction for checking the channel ID.
        Parameters:
        userId - the ID of the user for whom a command should be allowed

      • UserJavacord

        protected UserJavacord​(String userName)
        Constructs a new user restriction for checking the user name case-sensitively against a fixed name.
        Parameters:
        userName - the case-sensitive name of the user for whom a command should be allowed

      • UserJavacord

        protected UserJavacord​(String userName,
                       boolean caseSensitive)
        Constructs a new user restriction for checking the user name against a fixed name.
        Parameters:
        userName - the name of the user for whom a command should be allowed
        caseSensitive - whether the name should be matched case-sensitively or not

      • UserJavacord

        protected UserJavacord​(Pattern userPattern)
        Constructs a new user restriction for checking the user name against a regular expression.
        Parameters:
        userPattern - the pattern against which the user name is matched to determine for whom a command should be allowed

    • Method Detail

      • allowCommand

        public boolean allowCommand​(Message message)
        Description copied from interface: Restriction
        Returns whether a command caused by the given message should be allowed by this restriction or not.
        Specified by:
        allowCommand in interface Restriction<Message>
        Parameters:
        message - the message that caused the command to check allowance for
        Returns:
        whether a command caused by the given message should be allowed by this restriction or not