com.github.afarion1.command_handler.command

Class AbstractCommand

java.lang.Object

com.github.afarion1.command_handler.command.AbstractCommand

Direct Known Subclasses:

CmdCalculator, CmdCommandList, CmdDynamicCooldown, CmdInspectCommand

public abstract class AbstractCommand
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	argumentsSeparator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCommand(CommandHandler handler)

Method Summary

Modifier and Type	Method and Description
int	chooseArgumentSymbols(net.dv8tion.jda.api.events.message.MessageReceivedEvent event, java.lang.String strArgs, int argumentId) Designed to be overridden if CommandArgumentConfigBuilder.enableCustomArgumentChoosing(boolean) of any argument of the command is set to true.
abstract void	execute(net.dv8tion.jda.api.events.message.MessageReceivedEvent event, CommandArguments args)
java.lang.String	getCmdWithArgsSignature()
java.util.List<CommandArgumentConfig>	getCommandArguments()
CommandConfig	getConfig()
java.lang.String	getDescription()
java.time.Duration	getGuildCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)
CommandHandler	getHandler()
CommandListType	getListType()
java.lang.String	getName()
java.util.List<java.lang.String>	getNameAndAliases()
java.lang.String	getRawArgsDesc()
java.lang.String	getRawArgsName()
java.util.List<net.dv8tion.jda.api.Permission>	getRequiredDiscordPerms(net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Could be overridden for dynamic needed discord permissions calculation instead of static Config.
java.time.Duration	getUserCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Could be overridden for dynamic cooldown calculation instead of static Config.
java.lang.String	getVerboseDesc()
boolean	hasAnyCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)
boolean	hasGuildCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Could be overridden so getGuildCooldown(MessageReceivedEvent) doesn't get called to determine if there's any cooldown. Could be useful if the getGuildCooldown(MessageReceivedEvent) is overridden and has heavy operations.
boolean	hasUserCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Could be overridden so getUserCooldown(MessageReceivedEvent) doesn't get called to determine if there's any cooldown. Could be useful if the getUserCooldown(MessageReceivedEvent) is overridden and has heavy operations.
boolean	isExecuteInGuildOnly(net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Could be overridden for dynamic calculation instead of static Config.
boolean	isRawArgs()
boolean	shouldExecuteIfCantCheckOrSaveCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Could be overridden for dynamic calculation instead of static Config.

Methods inherited from class java.lang.Object

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

Field Detail

argumentsSeparator

public static final java.lang.String argumentsSeparator

See Also:

Constant Field Values

Constructor Detail

AbstractCommand

protected AbstractCommand(CommandHandler handler)

Method Detail

getConfig

public final CommandConfig getConfig()

getHandler

public final CommandHandler getHandler()

getName

public final java.lang.String getName()

getDescription

public final java.lang.String getDescription()

getVerboseDesc

public final java.lang.String getVerboseDesc()

getListType

public final CommandListType getListType()

getNameAndAliases

public final java.util.List<java.lang.String> getNameAndAliases()

Returns:

unmodifiable name and aliases list

getCommandArguments

public final java.util.List<CommandArgumentConfig> getCommandArguments()

Returns:

a list of CommandArgumentConfigBuilder which is backed by Command Handler, so changes to this list will affect the command's arguments

getCmdWithArgsSignature

public final java.lang.String getCmdWithArgsSignature()

isRawArgs

public final boolean isRawArgs()

getRawArgsDesc

public final java.lang.String getRawArgsDesc()

getRawArgsName

public final java.lang.String getRawArgsName()

isExecuteInGuildOnly

public boolean isExecuteInGuildOnly(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Could be overridden for dynamic calculation instead of static Config.

Parameters:

event - context for overriding

Returns:

true if the command should be executed only in a guild chat

hasUserCooldown

public boolean hasUserCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

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

Parameters:

event - context for overriding

Returns:

true if the command has user cooldown

hasGuildCooldown

public boolean hasGuildCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

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

Parameters:

event - context for overriding

Returns:

true if the command has guild cooldown

hasAnyCooldown

public final boolean hasAnyCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

shouldExecuteIfCantCheckOrSaveCooldown

public boolean shouldExecuteIfCantCheckOrSaveCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Could be overridden for dynamic calculation instead of static Config.

Parameters:

event - context for overriding

Returns:

true if the command should be executed even if there

getUserCooldown

public java.time.Duration getUserCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

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

Parameters:

event - context for overriding

Returns:

minimal duration between uses of the same command by the same user

getGuildCooldown

public java.time.Duration getGuildCooldown(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

getRequiredDiscordPerms

public java.util.List<net.dv8tion.jda.api.Permission> getRequiredDiscordPerms(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

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

Parameters:

event - context for overriding

Returns:

needed discord permission to execute the command

chooseArgumentSymbols

public int chooseArgumentSymbols(net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                                 java.lang.String strArgs,
                                 int argumentId)

Designed to be overridden if CommandArgumentConfigBuilder.enableCustomArgumentChoosing(boolean) of any argument of the command is set to true.
This method will have to choose amount of consecutive symbols right from the start of a string, the symbols will be value of the argument.
The method will be given MessageReceivedEvent for context, a String which represents the rest of unprocessed arguments sent by user, and ID of argument being processed.

Parameters:

event - jda on message received event, given for context

strArgs - string containing the rest of unprocessed arguments sent by user

argumentId - id of argument being processed. Necessary if several arguments marked to use custom argument choosing

Returns:

when overridden, should return amount of chosen symbols, it other words index of last symbol needed + 1

See Also:

CommandArgumentConfigBuilder.enableCustomArgumentChoosing(boolean)

execute

public abstract void execute(net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                             CommandArguments args)