A B C D E F G H I N O R S V

A

AbstractCommand - Class in com.github.afarion1.command_handler.command

AbstractCommand(CommandHandler) - Constructor for class com.github.afarion1.command_handler.command.AbstractCommand

addAliases(List<String>) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Adds an alias to the command which will work like additional name.

addAliases(String...) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Adds an alias to the command which will work like additional name.

addArguments(List<CommandArgumentConfigBuilder>) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Adds arguments to this command.

addArguments(CommandArgumentConfigBuilder...) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Adds arguments to this command.

addDiscordPermission(Permission) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Adds a Discord permission that will be required in order to execute the command.

addDiscordPermission(List<Permission>) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Adds Discord permissions that will be required in order to execute the command.

addDoubleValidators(DoublePredicate...) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

Adds predicates that will be used to validate double value.
The argument must also be set to CommandArgumentConfigBuilder.setParseToDouble(boolean)

addStringValidators(Predicate<String>...) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

Adds predicates that will be used to validate string value.

ARGS_OPTION_PREFIX - Static variable in class com.github.afarion1.command_handler.internal_commands.CmdCommandList

ARGS_OPTION_SUFFIX - Static variable in class com.github.afarion1.command_handler.internal_commands.CmdCommandList

argumentsSeparator - Static variable in class com.github.afarion1.command_handler.command.AbstractCommand

ARROW_LEFT - Static variable in class com.github.afarion1.command_handler.reaction_controls.pagination.ReactionPagination

B

build() - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

build() - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

C

chooseArgumentSymbols(MessageReceivedEvent, String, int) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

Designed to be overridden if CommandArgumentConfigBuilder.enableCustomArgumentChoosing(boolean) of any argument of the command is set to true.

chooseArgumentSymbols(MessageReceivedEvent, String, int) - Method in class com.github.afarion1.command_handler.internal_commands.CmdInspectCommand

cleanDbOnStartup(boolean) - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

Setting to false will prevent outdated cooldown entries from being deleted from the DB.

CmdCalculator - Class in com.github.afarion1.command_handler.example

CmdCalculator(CommandHandler) - Constructor for class com.github.afarion1.command_handler.example.CmdCalculator

CmdCommandList - Class in com.github.afarion1.command_handler.internal_commands

CmdCommandList(CommandHandler) - Constructor for class com.github.afarion1.command_handler.internal_commands.CmdCommandList

CmdDynamicCooldown - Class in com.github.afarion1.command_handler.example

CmdDynamicCooldown(CommandHandler) - Constructor for class com.github.afarion1.command_handler.example.CmdDynamicCooldown

CmdInspectCommand - Class in com.github.afarion1.command_handler.internal_commands

CmdInspectCommand(CommandHandler) - Constructor for class com.github.afarion1.command_handler.internal_commands.CmdInspectCommand

com.github.afarion1.command_handler.annotations - package com.github.afarion1.command_handler.annotations

com.github.afarion1.command_handler.command - package com.github.afarion1.command_handler.command

com.github.afarion1.command_handler.command.config - package com.github.afarion1.command_handler.command.config

com.github.afarion1.command_handler.example - package com.github.afarion1.command_handler.example

com.github.afarion1.command_handler.internal_commands - package com.github.afarion1.command_handler.internal_commands

com.github.afarion1.command_handler.reaction_controls - package com.github.afarion1.command_handler.reaction_controls

com.github.afarion1.command_handler.reaction_controls.pagination - package com.github.afarion1.command_handler.reaction_controls.pagination

com.github.afarion1.command_handler.utils - package com.github.afarion1.command_handler.utils

Command - Annotation Type in com.github.afarion1.command_handler.annotations

Used to register a subclass of AbstractCommand to be handled.
The command is expected to have a constructor with a single parameter of CommandHandler and a CommandConfig instance inside a field/method annotated with Config.
To use other constructor, use CommandHandler.registerCommand(Class, Function, CommandConfig) instead

CommandArgumentConfig - Class in com.github.afarion1.command_handler.command.config

Represents configuration of argument

CommandArgumentConfigBuilder - Class in com.github.afarion1.command_handler.command.config

A sub-builder for CommandConfigBuilder, used in CommandConfigBuilder.addArguments(CommandArgumentConfigBuilder...)
Changes to this builder won't affect arguments configuration once CommandConfigBuilder.build() is called.

CommandArgumentConfigBuilder(int, String) - Constructor for class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

Default values: has no description isn't optional has no default string value shouldn't be parsed to Double has no default double value shouldn't be in quotes multi word choosing is disabled

CommandArguments - Class in com.github.afarion1.command_handler.command

CommandConfig - Class in com.github.afarion1.command_handler.command.config

Represent configuration of command

CommandConfigBuilder - Class in com.github.afarion1.command_handler.command.config

A builder for convenient CommandConfig instance creation.

CommandConfigBuilder(String) - Constructor for class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Creates a configuration builder for a AbstractCommand.
The default setting are following:
has no description is visible in list of commands, etc. doesn't require any discord permissions has no cooldown has no per guild cooldown has no arguments doesn't use raw arguments could be executed not only in guild chat shouldn't be executed if can't check cooldown (db problems) command's cooldown entries should be cleared on startup if they are outdated

CommandHandler - Class in com.github.afarion1.command_handler.command

Represents CommandHandler entity.

CommandHandlerBuilder - Class in com.github.afarion1.command_handler.command

Represents configuration of Command handler for convenient instance building.
Parameters set through methods override the ones from config file.

CommandHandlerBuilder() - Constructor for class com.github.afarion1.command_handler.command.CommandHandlerBuilder

Creates fluent configuration object for CommandHandler instance creation.
Equivalent of CommandHandlerBuilder.CommandHandlerBuilder(boolean) with parameter true.

CommandHandlerBuilder(boolean) - Constructor for class com.github.afarion1.command_handler.command.CommandHandlerBuilder

Creates fluent configuration object for CommandHandler instance creation.
The single parameter determines whether a configuration file should be created in root directory.

CommandListType - Enum in com.github.afarion1.command_handler.command.config

Config - Annotation Type in com.github.afarion1.command_handler.annotations

Used to mark configuration object CommandConfig for command registration.
The annotation is expected to be inside of a subclass of AbstractCommand next to a field containing CommandConfig or a static method returning the CommandConfig.

D

disableCommandList() - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

Disables internal Command List command.

disableInspectCommand() - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

Disables internal Inspect Command command.

E

enableCustomArgumentChoosing(boolean) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

Setting this to true enables custom argument choosing.

execute(MessageReceivedEvent, CommandArguments) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

execute(MessageReceivedEvent, CommandArguments) - Method in class com.github.afarion1.command_handler.example.CmdCalculator

execute(MessageReceivedEvent, CommandArguments) - Method in class com.github.afarion1.command_handler.example.CmdDynamicCooldown

execute(MessageReceivedEvent, CommandArguments) - Method in class com.github.afarion1.command_handler.internal_commands.CmdCommandList

execute(MessageReceivedEvent, CommandArguments) - Method in class com.github.afarion1.command_handler.internal_commands.CmdInspectCommand

F

findCommandAndGetConfig(String) - Method in class com.github.afarion1.command_handler.command.CommandHandler

Useful for custom command inspection implementation.

G

getAllCommandNamesAndAliases() - Method in class com.github.afarion1.command_handler.command.CommandHandler

Useful for custom command inspection implementation.

getArgumentDesc() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getArgumentName() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getArgumentOptions() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getArguments() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getCmdWithArgsSignature() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getCommandArguments() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getCommandArgumentsSignature() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getCommandListColor() - Method in class com.github.afarion1.command_handler.command.CommandHandler

getCommandsPrefix() - Method in class com.github.afarion1.command_handler.command.CommandHandler

getConfig() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getCooldownRecordsCleaningPeriod() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getDefaultDoubleValue() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getDefaultStringValue() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getDescription() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getDescription() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getDiscordPerms() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getDoubleArgumentValue(int) - Method in class com.github.afarion1.command_handler.command.CommandArguments

getDoubleValidators() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getErrorColor() - Method in class com.github.afarion1.command_handler.command.CommandHandler

getErrorMsg() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getGuildCooldown(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getGuildCooldown() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getHandler() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getId() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getInspectCommandColor() - Method in class com.github.afarion1.command_handler.command.CommandHandler

getJda() - Method in class com.github.afarion1.command_handler.command.CommandHandler

getListType() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getListType() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getName() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getName() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getNameAndAliases() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getNameAndAliases() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getRawArgs() - Method in class com.github.afarion1.command_handler.command.CommandArguments

getRawArgsDesc() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getRawArgsDesc() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getRawArgsName() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getRawArgsName() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getRequiredDiscordPerms(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

Could be overridden for dynamic needed discord permissions calculation instead of static Config.

getStringArgumentValue(int) - Method in class com.github.afarion1.command_handler.command.CommandArguments

getStringValidators() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

getUserCooldown(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

Could be overridden for dynamic cooldown calculation instead of static Config.

getUserCooldown() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getUserCooldown(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.example.CmdDynamicCooldown

getVerboseDesc() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

getVerboseDesc() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

getVisibleCommandConfigList() - Method in class com.github.afarion1.command_handler.command.CommandHandler

Useful for custom command list implementation.

H

hasAnyCooldown(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

hasGuildCooldown(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

Could be overridden so AbstractCommand.getGuildCooldown(MessageReceivedEvent) doesn't get called to determine if there's any cooldown.
Could be useful if the AbstractCommand.getGuildCooldown(MessageReceivedEvent) is overridden and has heavy operations.

hasUserCooldown(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

Could be overridden so AbstractCommand.getUserCooldown(MessageReceivedEvent) doesn't get called to determine if there's any cooldown.
Could be useful if the AbstractCommand.getUserCooldown(MessageReceivedEvent) is overridden and has heavy operations.

hasUserCooldown(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.example.CmdDynamicCooldown

I

isArgumentPresent(int) - Method in class com.github.afarion1.command_handler.command.CommandArguments

isCommandListEnabled() - Method in class com.github.afarion1.command_handler.command.CommandHandler

isExecuteInGuildOnly(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

Could be overridden for dynamic calculation instead of static Config.

isExecuteInGuildOnly() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

isInQuotes() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

isInspectCommandEnabled() - Method in class com.github.afarion1.command_handler.command.CommandHandler

isMultiWordChoosingEnabled() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

isOptional() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

isParseToDouble() - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfig

isRawArgs() - Method in class com.github.afarion1.command_handler.command.AbstractCommand

isRawArgs() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

N

NamedThreadFactory - Class in com.github.afarion1.command_handler.utils

NamedThreadFactory(String) - Constructor for class com.github.afarion1.command_handler.utils.NamedThreadFactory

necessaryArgsPrefix - Static variable in class com.github.afarion1.command_handler.internal_commands.CmdCommandList

necessaryArgsSuffix - Static variable in class com.github.afarion1.command_handler.internal_commands.CmdCommandList

newThread(Runnable) - Method in class com.github.afarion1.command_handler.utils.NamedThreadFactory

O

onMessageReactionAdd(MessageReactionAddEvent) - Method in class com.github.afarion1.command_handler.reaction_controls.ReactionListener

optionalArgsPrefix - Static variable in class com.github.afarion1.command_handler.internal_commands.CmdCommandList

optionalArgsSuffix - Static variable in class com.github.afarion1.command_handler.internal_commands.CmdCommandList

R

ReactionListener - Class in com.github.afarion1.command_handler.reaction_controls

ReactionListener() - Constructor for class com.github.afarion1.command_handler.reaction_controls.ReactionListener

ReactionObserver - Class in com.github.afarion1.command_handler.reaction_controls

ReactionObserver() - Constructor for class com.github.afarion1.command_handler.reaction_controls.ReactionObserver

ReactionPagination - Class in com.github.afarion1.command_handler.reaction_controls.pagination

ReactionPagination() - Constructor for class com.github.afarion1.command_handler.reaction_controls.pagination.ReactionPagination

ReactionPaginationConfigBuilder - Class in com.github.afarion1.command_handler.reaction_controls.pagination

ReactionPaginationConfigBuilder() - Constructor for class com.github.afarion1.command_handler.reaction_controls.pagination.ReactionPaginationConfigBuilder

registerCommand(Class<T>, Function<CommandHandler, T>, CommandConfig) - Method in class com.github.afarion1.command_handler.command.CommandHandler

Registers a command to be handled.
Command annotation could be used alternatively, it is usually more convenient.
Unlike using annotation to register, using the method provides an option to use a different from the AbstractCommand super class constructor for the command class.

registerCommand(Class<T>, Function<CommandHandler, T>) - Method in class com.github.afarion1.command_handler.command.CommandHandler

Convenience method, equals to CommandHandler.registerCommand(Class, Function, CommandConfig) with 3rd parameter of null.

registerCommand(Class<T>, CommandConfig) - Method in class com.github.afarion1.command_handler.command.CommandHandler

Convenience method, equals to CommandHandler.registerCommand(Class, Function, CommandConfig) with 2nd parameter of null.

registerCommand(Class<T>) - Method in class com.github.afarion1.command_handler.command.CommandHandler

Convenience method, equals to CommandHandler.registerCommand(Class, Function, CommandConfig) with 2nd and 3rd parameters of null.

S

setArgumentDescription(String) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

The description will be shown in command inspection (command info) and in wrong-command-usage error message

setArgumentOptions(String...) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

Execution of the argument's command will fail if given argument value doesn't match these options.

setCleanCooldownRecords(boolean) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Should outdated records of cooldown of the command be cleared.
Default is true.

setCommandListEmbedColor(Color) - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

setCommandListType(CommandListType) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Sets visibility of the command.

setCommandPrefix(String) - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

Default prefix is ~

setCooldown(Duration) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

The same user will have to wait the duration before being able to execute the command again

setDefaultDoubleValue(double) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

Sets default value that will be used if the argument is omitted.

setDefaultStringValue(String) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

Sets default value that will be used if the argument is omitted.

setDescription(String) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Sets a description that will be displayed in list of commands and in commands information (inspection)

setErrorEmbedColor(Color) - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

setExecuteIfCantCheckOrSaveCooldown(boolean) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Setting to true will allow the command to be used when there are problems with DB.

setExecuteInGuildOnly(boolean) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

When set to true the command won't be accessible in DM chat.

setExecutorService(ExecutorService) - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

A thread pool with size of available processors amount is used by default.

setInQuotes(boolean) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

When set to true the argument will have to be typed in quotes (" ").
This is useful for separation of arguments with spaces.

setInspectCommandEmbedColor(Color) - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

setJda(JDA) - Method in class com.github.afarion1.command_handler.command.CommandHandlerBuilder

setOptional(boolean) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

When set to true the argument will be optional and could be omitted.

setParseToDouble(boolean) - Method in class com.github.afarion1.command_handler.command.config.CommandArgumentConfigBuilder

When set to true the argument's value will be parsed to Double and will be accessible using CommandArguments.getDoubleArgumentValue(int).

setPerGuildCooldown(Duration) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

The command will be accessible in the same guild only after the duration since the last use.

setRawArgsDesc(String) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Sets description of the raw args which will be displayed in verbose description of the command if usage of raw args is enabled.

setRawArgsName(String) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Sets name of the raw args which will be used in signature and description of the command, if usage of raw args is enabled.

setUseRawArgs(boolean) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

Sets this command to use raw args, which means the arguments values will be accessible as a one String or as List of the string separated by spaces instead of IDs and all the features coming from CommandArgumentConfigBuilder won't be available.

setVerboseDescription(String) - Method in class com.github.afarion1.command_handler.command.config.CommandConfigBuilder

The verbose description will be used in command inspection (command info command)

setWithDelete(boolean) - Method in class com.github.afarion1.command_handler.reaction_controls.pagination.ReactionPaginationConfigBuilder

setWithFastForward(boolean) - Method in class com.github.afarion1.command_handler.reaction_controls.pagination.ReactionPaginationConfigBuilder

setWithNumPad(boolean) - Method in class com.github.afarion1.command_handler.reaction_controls.pagination.ReactionPaginationConfigBuilder

shouldCleanCooldownRecords() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

shouldExecuteIfCantCheckOrSaveCooldown(MessageReceivedEvent) - Method in class com.github.afarion1.command_handler.command.AbstractCommand

Could be overridden for dynamic calculation instead of static Config.

shouldExecuteIfCantCheckOrSaveCooldown() - Method in class com.github.afarion1.command_handler.command.config.CommandConfig

start() - Method in class com.github.afarion1.command_handler.command.CommandHandler

Initializes and starts listening for messages.

V

valueOf(String) - Static method in enum com.github.afarion1.command_handler.command.config.CommandListType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.afarion1.command_handler.command.config.CommandListType

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I N O R S V