Package com.github.johnnyjayjay.discord.commandapi

Class AbstractCommand

java.lang.Object

com.github.johnnyjayjay.discord.commandapi.AbstractCommand

All Implemented Interfaces:

ICommand

public abstract class AbstractCommand
extends Object
implements ICommand

This abstract class is an alternative implementation of ICommand. Instead of implementing ICommand directly, you may create sub classes of this class and register them as commands. This class provides the possibility to use sub commands, making it possible to annotate methods as SubCommand methods. To learn more about using sub commands, please refer to the readme on github.

Since:

3.2

Version:

3.2

Author:

JohnnyJayJay

See Also:

ICommand

Field Summary

Fields

Modifier and Type	Field	Description
protected String	CHANNEL_MENTION	A regex to match text channel mentions.
protected String	MEMBER_MENTION	A regex to match member mentions.
protected String	ROLE_MENTION	A regex to match role mentions.

Fields inherited from interface com.github.johnnyjayjay.discord.commandapi.ICommand

DEFAULT_INFO

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCommand()	Iterates over the SubCommand-annotated methods and saves them in a cache.

Method Summary

Modifier and Type	Method	Description
void	onCommand(CommandEvent event, net.dv8tion.jda.core.entities.Member member, net.dv8tion.jda.core.entities.TextChannel channel, String[] args)	This overrides the method declared in ICommand.

Methods inherited from interface com.github.johnnyjayjay.discord.commandapi.ICommand

info, info

Methods inherited from class java.lang.Object

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

Field Detail

MEMBER_MENTION

protected final String MEMBER_MENTION

A regex to match member mentions.

See Also:

Constant Field Values

ROLE_MENTION

protected final String ROLE_MENTION

A regex to match role mentions.

See Also:

Constant Field Values

CHANNEL_MENTION

protected final String CHANNEL_MENTION

A regex to match text channel mentions.

See Also:

Constant Field Values

Constructor Detail

AbstractCommand

protected AbstractCommand()

Iterates over the SubCommand-annotated methods and saves them in a cache.

Method Detail

onCommand

public final void onCommand(CommandEvent event,
                            net.dv8tion.jda.core.entities.Member member,
                            net.dv8tion.jda.core.entities.TextChannel channel,
                            String[] args)

This overrides the method declared in ICommand. It is final, thus it may not be overwritten. To define own command methods in a sub class of this class, refer to the SubCommand-annotation.
See the examples and the readme on github for further information.

Specified by:

onCommand in interface ICommand

Parameters:

event - The CommandEvent instance for this execution.

member - The member who called the command.

channel - The TextChannel in which the command has been called.

args - The command arguments, i.e. everything behind the label ([prefix][label] [arg1] [arg2]...)

See Also:

SubCommand