Package cloud.commandframework.javacord

Class JavacordCommandManager<C>

java.lang.Object
cloud.commandframework.CommandManager<C>
cloud.commandframework.javacord.JavacordCommandManager<C>
public class JavacordCommandManager<C> extends cloud.commandframework.CommandManager<C>

  • Nested Class Summary

    Nested classes/interfaces inherited from class cloud.commandframework.CommandManager

    cloud.commandframework.CommandManager.ManagerSettings, cloud.commandframework.CommandManager.RegistrationState

  • Constructor Summary

    Constructors
    Constructor
    Description
    JavacordCommandManager(@NonNull org.javacord.api.DiscordApi discordApi, @NonNull Function<@NonNull cloud.commandframework.CommandTree<C>,@NonNull cloud.commandframework.execution.CommandExecutionCoordinator<C>> commandExecutionCoordinator, @NonNull Function<@NonNull JavacordCommandSender,@NonNull C> commandSenderMapper, @NonNull Function<@NonNull C,@NonNull JavacordCommandSender> backwardsCommandSenderMapper, @NonNull Function<@NonNull C,@NonNull String> commandPrefixMapper, @Nullable BiFunction<@NonNull C,@NonNull String,@NonNull Boolean> commandPermissionMapper)
    Construct a new Javacord command manager

  • Method Summary

    Modifier and Type
    Method
    Description
    final @NonNull cloud.commandframework.meta.SimpleCommandMeta
    createDefaultCommandMeta()
     
    @NonNull String
    getCommandPrefix(@NonNull C sender)
    Gets the current command prefix
    @NonNull org.javacord.api.DiscordApi
    getDiscordApi()
    Gets the DiscordApi instance
    final boolean
    hasPermission(@NonNull C sender, @NonNull String permission)
     

    Methods inherited from class cloud.commandframework.CommandManager

    argumentBuilder, capabilities, captionRegistry, captionRegistry, captionVariableReplacementHandler, captionVariableReplacementHandler, command, command, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandExecutionCoordinator, commandRegistrationHandler, commandRegistrationHandler, commands, commandSuggestionProcessor, commandSuggestionProcessor, commandSyntaxFormatter, commandSyntaxFormatter, commandTree, createCommandHelpHandler, createCommandHelpHandler, deleteRootCommand, executeCommand, flagBuilder, getCaptionRegistry, getCommandHelpHandler, getCommandHelpHandler, getCommandRegistrationHandler, getCommands, getCommandSuggestionProcessor, getCommandSyntaxFormatter, getCommandTree, getExceptionHandler, getParserRegistry, getRegistrationState, getSetting, handleException, hasCapability, hasPermission, isCommandRegistrationAllowed, lockRegistration, parameterInjectorRegistry, parserRegistry, postprocessContext, preprocessContext, registerCapability, registerCommandPostProcessor, registerCommandPreProcessor, registerDefaultCaptions, registerExceptionHandler, registrationState, requireState, rootCommands, setCaptionRegistry, setCommandRegistrationHandler, setCommandSuggestionProcessor, setCommandSyntaxFormatter, setSetting, suggest, transitionIfPossible, transitionOrThrow

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • JavacordCommandManager

      public JavacordCommandManager(@NonNull org.javacord.api.DiscordApi discordApi, @NonNull Function<@NonNull cloud.commandframework.CommandTree<C>,@NonNull cloud.commandframework.execution.CommandExecutionCoordinator<C>> commandExecutionCoordinator, @NonNull Function<@NonNull JavacordCommandSender,@NonNull C> commandSenderMapper, @NonNull Function<@NonNull C,@NonNull JavacordCommandSender> backwardsCommandSenderMapper, @NonNull Function<@NonNull C,@NonNull String> commandPrefixMapper, @Nullable BiFunction<@NonNull C,@NonNull String,@NonNull Boolean> commandPermissionMapper)
      Construct a new Javacord command manager
      Parameters:
      discordApi - Instance of DiscordApi used to register listeners
      commandExecutionCoordinator - Coordinator provider
      commandSenderMapper - Function that maps Object to the command sender type
      backwardsCommandSenderMapper - Function that maps the command sender type to Object
      commandPrefixMapper - Function that maps the command sender type to the command prefix
      commandPermissionMapper - Function used to check if a command sender has the permission to execute a command

  • Method Details

    • hasPermission

      public final boolean hasPermission(@NonNull C sender, @NonNull String permission)
      Specified by:
      hasPermission in class cloud.commandframework.CommandManager<C>

    • createDefaultCommandMeta

      public final @NonNull cloud.commandframework.meta.SimpleCommandMeta createDefaultCommandMeta()
      Specified by:
      createDefaultCommandMeta in class cloud.commandframework.CommandManager<C>

    • getCommandPrefix

      public @NonNull String getCommandPrefix(@NonNull C sender)
      Gets the current command prefix
      Parameters:
      sender - Sender used to get the prefix (probably won't used anyways)
      Returns:
      the command prefix

    • getDiscordApi

      public @NonNull org.javacord.api.DiscordApi getDiscordApi()
      Gets the DiscordApi instance
      Returns:
      Current DiscordApi instance