com.ericramirezs.commando4j

Interface ICommandEngine

All Known Implementing Classes:

CommandEngine

public interface ICommandEngine

Method Summary

Modifier and Type	Method and Description
ICommandEngine	addAlias(String name, ICommand command) Add an alternative name to a command.
ICommandEngine	addCommand(ICommand command) Registers an ICommand into the engine.
ICommand	getCommand(String name) Get an ICommand from the registered commands in the Engine.
List<ICommand>	getCommands() Get a list of ICommand registered in the Engine.
List<ICommand>	getCommandsByExactMatch(String name) Get a list of ICommand from the registered commands in the Engine.
List<ICommand>	getCommandsByPartialMatch(String name) Get a list of ICommand from the registered commands in the Engine.
ICommand	getHelpCommand() Return the ICommand object of the help command.
Locale	getLanguage() Gets the default language to be used by the bot.
Locale	getLanguage(net.dv8tion.jda.api.events.Event event) By default, gets the default language to be used by the bot.
String	getPrefix() Gets the prefix configured on the bot.
String	getPrefix(net.dv8tion.jda.api.events.Event event) By default, it gets the prefix configured on the bot.
String	getPrefix(net.dv8tion.jda.api.events.message.MessageReceivedEvent event) By default, it gets the prefix configured on the bot.
String	getPrefix(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event) By default, it gets the prefix configured on the bot.
IRepository	getRepository() Return the repository Controller.
String	getString(String key) Gets a text string in the configured language of the bot.
String	getString(String key, Locale locale) Gets a text string in a specific language.
String[]	getStringArray(String key) Gets a string Array in the configured language of the bot.
String[]	getStringArray(String key, Locale locale) Gets a string Array in a specific language.
boolean	isReactToMention() Get whether the bot should react to mention or not.
boolean	isReactToMention(net.dv8tion.jda.api.events.Event event) Checks if bot should react to mention calls (Messages that starts with @BOT_NAME).
void	loadCommands() Registers ICommands from packages set into the engine.
void	logDebug(String message) Log a message at the DEBUG level.
void	logError(String message) Log a message at the ERROR level.
void	logInfo(String message) Log a message at the INFO level.
void	logWarn(String message) Log a message at the WARN level.
ICommandEngine	setHelp(String help) Set which command is related to user help.
ICommandEngine	setLanguage(Locale language) Sets the default language to be used by the bot.
ICommandEngine	setPrefix(net.dv8tion.jda.api.entities.Guild guild, String prefix) Sets a prefix for a specific guild.
ICommandEngine	setPrefix(String prefix) Sets the default prefix for the bot.
ICommandEngine	setReactToMention(boolean reactToMention) Sets if the bot should react to a message starting by mentioning the bot @bot_name if sets to false, the bot will only react to prefix.

Method Detail

logWarn

void logWarn(String message)

Log a message at the WARN level.

Parameters:

message - the message string to be logged

logDebug

void logDebug(String message)

Log a message at the DEBUG level.

Parameters:

message - the message string to be logged

logInfo

void logInfo(String message)

Log a message at the INFO level.

Parameters:

message - the message string to be logged

logError

void logError(String message)

Log a message at the ERROR level.

Parameters:

message - the message string to be logged

setHelp

ICommandEngine setHelp(String help)

Set which command is related to user help. The command will be recommended if the user fails to use a command.

Parameters:

help - command name

Returns:

A reference to this object.

See Also:

HelpCommand

getHelpCommand

ICommand getHelpCommand()

Return the ICommand object of the help command.

Returns:

Help Command object.

isReactToMention

boolean isReactToMention()

Get whether the bot should react to mention or not.

Returns:

True if the bot should react to mention calls.

setReactToMention

ICommandEngine setReactToMention(boolean reactToMention)

Sets if the bot should react to a message starting by mentioning the bot @bot_name if sets to false, the bot will only react to prefix.

Parameters:

reactToMention - True if the bot should react to mention calls.

Returns:

A reference to this object.

See Also:

getPrefix(MessageReceivedEvent)

loadCommands

void loadCommands()

Registers ICommands from packages set into the engine. It also registers into JDA any ICommand object that also implements Slash.

isReactToMention

boolean isReactToMention(net.dv8tion.jda.api.events.Event event)

Checks if bot should react to mention calls (Messages that starts with @BOT_NAME).

Parameters:

event - Discord event that triggered this function call.

Returns:

true if the bot should react to mention, false if only reacts to prefix.

getCommand

ICommand getCommand(String name)

Get an ICommand from the registered commands in the Engine.

Parameters:

name - command's name.

Returns:

ICommand instance.

See Also:

ICommand

getCommandsByPartialMatch

List<ICommand> getCommandsByPartialMatch(String name)

Get a list of ICommand from the registered commands in the Engine.

Parameters:

name - partial command's name.

Returns:

List of ICommand that match the partial search.

getCommandsByExactMatch

List<ICommand> getCommandsByExactMatch(String name)

Get a list of ICommand from the registered commands in the Engine.

Parameters:

name - expected command's name.

Returns:

List of ICommand that match the search.

getCommands

List<ICommand> getCommands()

Get a list of ICommand registered in the Engine.

Returns:

list of ICommand instances loaded in the Engine.

addCommand

ICommandEngine addCommand(ICommand command)
                   throws DuplicatedNameException,
                          InvalidNameException

Registers an ICommand into the engine.

Parameters:

command - The command to be registered.

Returns:

A reference to this object.

Throws:

DuplicatedNameException - Error if there's another command with the same name or alias registered.

InvalidNameException - Error if the command doesn't match the expected name.

addAlias

ICommandEngine addAlias(String name,
                        ICommand command)
                 throws DuplicatedNameException,
                        InvalidNameException

Add an alternative name to a command.

Parameters:

name - alternative name.

command - Command to be called.

Returns:

A reference to this object.

Throws:

DuplicatedNameException - Thrown when there's already a commando with the same name/alias.

InvalidNameException - Thrown when the command's alias uses non-alphanumeric characters.

getPrefix

String getPrefix(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

By default, it gets the prefix configured on the bot. May be used to get a prefix based on the guild.

Parameters:

event - Message Received event that triggered this request.

Returns:

prefix string.

getPrefix

String getPrefix(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event)

By default, it gets the prefix configured on the bot. May be used to get a prefix based on the guild.

Parameters:

event - Slash command that triggered this request.

Returns:

prefix string.

getPrefix

String getPrefix(net.dv8tion.jda.api.events.Event event)

By default, it gets the prefix configured on the bot. May be used to get a prefix based on the guild.

Parameters:

event - Event that triggered this request.

Returns:

prefix string.

getPrefix

String getPrefix()

Gets the prefix configured on the bot.

Returns:

prefix string.

setPrefix

ICommandEngine setPrefix(String prefix)

Sets the default prefix for the bot.

Parameters:

prefix - prefix string.

Returns:

A reference to this object.

setPrefix

ICommandEngine setPrefix(net.dv8tion.jda.api.entities.Guild guild,
                         String prefix)

Sets a prefix for a specific guild.

Parameters:

guild - Guild object.

prefix - prefix String.

Returns:

A reference to this object.

getLanguage

Locale getLanguage()

Gets the default language to be used by the bot.

Returns:

current language.

See Also:

MultiLocaleResourceBundle.getSupportedLocale()

setLanguage

ICommandEngine setLanguage(Locale language)

Sets the default language to be used by the bot.

Parameters:

language - Locale to use.

Returns:

A reference to this object.

See Also:

MultiLocaleResourceBundle.getSupportedLocale()

getLanguage

Locale getLanguage(net.dv8tion.jda.api.events.Event event)

By default, gets the default language to be used by the bot. May be used to get a Locale based on the Guild information.

Parameters:

event - Discord event that triggered this function call.

Returns:

current language.

See Also:

MultiLocaleResourceBundle.getSupportedLocale()

getString

String getString(String key)

Gets a text string in the configured language of the bot.

Parameters:

key - String key in resourceBundle.

Returns:

String in the current language.

getString

String getString(String key,
                 Locale locale)

Gets a text string in a specific language.

Parameters:

key - String key in resourceBundle.

locale - expected language.

Returns:

String in the specific language.

getStringArray

String[] getStringArray(String key)

Gets a string Array in the configured language of the bot.

Parameters:

key - String key in resourceBundle.

Returns:

String in the current language.

getStringArray

String[] getStringArray(String key,
                        Locale locale)

Gets a string Array in a specific language.

Parameters:

key - String key in resourceBundle.

locale - Expected language.

Returns:

String in the specific language.

getRepository

IRepository getRepository()

Return the repository Controller.

Returns:

IRepository object.