com.github.afarion1.command_handler.command

Class CommandHandler

java.lang.Object

com.github.afarion1.command_handler.command.CommandHandler

public final class CommandHandler
extends java.lang.Object

Represents CommandHandler entity. Note that running several CommandHandlers in one project is not yet supported (they would share config files and cooldown tables in database).

Method Summary

Modifier and Type	Method and Description
CommandConfig	findCommandAndGetConfig(java.lang.String name) Useful for custom command inspection implementation.
java.util.Set<java.lang.String>	getAllCommandNamesAndAliases() Useful for custom command inspection implementation.
java.awt.Color	getCommandListColor()
java.lang.String	getCommandsPrefix()
java.awt.Color	getErrorColor()
java.awt.Color	getInspectCommandColor()
net.dv8tion.jda.api.JDA	getJda()
java.util.List<CommandConfig>	getVisibleCommandConfigList() Useful for custom command list implementation.
boolean	isCommandListEnabled()
boolean	isInspectCommandEnabled()
<T extends AbstractCommand> void	registerCommand(java.lang.Class<T> aClass) Convenience method, equals to registerCommand(Class, Function, CommandConfig) with 2nd and 3rd parameters of null.
<T extends AbstractCommand> void	registerCommand(java.lang.Class<T> aClass, CommandConfig config) Convenience method, equals to registerCommand(Class, Function, CommandConfig) with 2nd parameter of null.
<T extends AbstractCommand> void	registerCommand(java.lang.Class<T> aClass, java.util.function.Function<CommandHandler,T> supplier) Convenience method, equals to registerCommand(Class, Function, CommandConfig) with 3rd parameter of null.
<T extends AbstractCommand> void	registerCommand(@NotNull java.lang.Class<T> aClass, java.util.function.Function<CommandHandler,T> function, CommandConfig config) 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.
void	start() Initializes and starts listening for messages.

Methods inherited from class java.lang.Object

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

Method Detail

start

public void start()

Initializes and starts listening for messages.
Commands should be registered before calling the method.

See Also:

registerCommand(Class, Function, CommandConfig), Command

registerCommand

public <T extends AbstractCommand> void registerCommand(@NotNull
                                                        @NotNull java.lang.Class<T> aClass,
                                                        java.util.function.Function<CommandHandler,T> function,
                                                        CommandConfig config)

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.
Function and config parameters could be null, overloaded versions of the method are present for convenience.

Type Parameters:

T - subclass of AbstractCommand

Parameters:

aClass - class of the command

function - a function to provide instances of the command with different from the AbstractCommand super class constructor. A reference to CommandHandler is given for super() call inside of the constructor. If the parameter is null, a constructor with single parameter of CommandHandler is expected

config - configuration of the command. If the parameter is null, the configuration CommandConfig object is expected to be annotated with Config inside of the command's class

See Also:

Command, Config, CommandConfigBuilder

registerCommand

public <T extends AbstractCommand> void registerCommand(java.lang.Class<T> aClass,
                                                        java.util.function.Function<CommandHandler,T> supplier)

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

See Also:

registerCommand(Class, Function, CommandConfig)

registerCommand

public <T extends AbstractCommand> void registerCommand(java.lang.Class<T> aClass,
                                                        CommandConfig config)

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

See Also:

registerCommand(Class, Function, CommandConfig)

registerCommand

public <T extends AbstractCommand> void registerCommand(java.lang.Class<T> aClass)

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

See Also:

registerCommand(Class, Function, CommandConfig)

getVisibleCommandConfigList

public java.util.List<CommandConfig> getVisibleCommandConfigList()

Useful for custom command list implementation.

Returns:

unmodifiable list of all CommandConfig with CommandListType.LISTED

getAllCommandNamesAndAliases

public java.util.Set<java.lang.String> getAllCommandNamesAndAliases()

Useful for custom command inspection implementation.

Returns:

unmodifiable set of all command names and aliases

See Also:

CmdInspectCommand

findCommandAndGetConfig

public CommandConfig findCommandAndGetConfig(java.lang.String name)

Useful for custom command inspection implementation.

Returns:

a config or null if the config wasn't found

See Also:

CmdInspectCommand

getJda

public net.dv8tion.jda.api.JDA getJda()

Returns:

JDA that is used to listen to messages

getCommandsPrefix

public java.lang.String getCommandsPrefix()

Returns:

default prefix for command call recognition

getCommandListColor

public java.awt.Color getCommandListColor()

Returns:

color of command list's embed

getErrorColor

public java.awt.Color getErrorColor()

Returns:

color of command error's embed

getInspectCommandColor

public java.awt.Color getInspectCommandColor()

Returns:

color of inspect command's embed

isCommandListEnabled

public boolean isCommandListEnabled()

Returns:

true if command list is enabled, false otherwise

isInspectCommandEnabled

public boolean isInspectCommandEnabled()

Returns:

true if inspect command is enabled, false otherwise