Package com.github.rainestormee.jdacommand

Class CommandHandler<T>

java.lang.Object

com.github.rainestormee.jdacommand.CommandHandler<T>

public class CommandHandler<T>
extends java.lang.Object

The CommandHandler which deals with the registered AbstractCommands.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
CommandHandler()

Method Summary

Modifier and Type	Method	Description
void	execute(AbstractCommand command, T message, java.lang.String args)	Method which attempts to execute the given AbstractCommand.
void	findAndExecute(java.lang.String trigger, T message, java.lang.String args)	A method which calls findCommand(String), and then #execute(AbstractCommand, T, String) if the found AbstractCommand is not null
AbstractCommand	findCommand(java.lang.String trigger)	Method which attempts to find a AbstractCommand from the given trigger
java.util.Set<AbstractCommand>	getCommands()	A method to get all of the AbstractCommands registered with this CommandHandler
void	registerCommand(AbstractCommand command)	A method to register a AbstractCommand with this CommandHandler.
void	registerCommands(AbstractCommand... commands)	A method to register AbstractCommands with this CommandHandler.
void	registerCommands(java.util.Set<AbstractCommand> commands)	A method to register AbstractCommands with this CommandHandler.
void	unregisterCommand(AbstractCommand command)	A method to unregister a AbstractCommand with this CommandHandler.
void	unregisterCommands(AbstractCommand... commands)	A method to unregister AbstractCommands with this CommandHandler.
void	unregisterCommands(java.util.Set<AbstractCommand> commands)	A method to unregister AbstractCommands with this CommandHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandHandler

public CommandHandler()

Method Detail

registerCommands

public void registerCommands(java.util.Set<AbstractCommand> commands)

A method to register AbstractCommands with this CommandHandler.

Parameters:

commands - The AbstractCommands to register.

Since:

1.0.0

See Also:

registerCommand(AbstractCommand)

registerCommands

public void registerCommands(AbstractCommand... commands)

A method to register AbstractCommands with this CommandHandler.

Parameters:

commands - The AbstractCommands to register.

Since:

1.0.1

See Also:

registerCommand(AbstractCommand), registerCommands(Set)

registerCommand

public void registerCommand(AbstractCommand command)

A method to register a AbstractCommand with this CommandHandler.

Parameters:

command - The AbstractCommand to register.

Since:

1.0.1

See Also:

registerCommands(Set)

unregisterCommands

public void unregisterCommands(java.util.Set<AbstractCommand> commands)

A method to unregister AbstractCommands with this CommandHandler.

Parameters:

commands - The commands to unregister.

Since:

1.0.1

See Also:

unregisterCommand(AbstractCommand), unregisterCommands(Set)

unregisterCommands

public void unregisterCommands(AbstractCommand... commands)

A method to unregister AbstractCommands with this CommandHandler.

Parameters:

commands - The commands to unregister.

Since:

1.0.1

See Also:

unregisterCommand(AbstractCommand), unregisterCommands(Set)

unregisterCommand

public void unregisterCommand(AbstractCommand command)

A method to unregister a AbstractCommand with this CommandHandler.

Parameters:

command - The command to unregister.

Since:

1.0.1

See Also:

unregisterCommands(Set), unregisterCommands(AbstractCommand...)

getCommands

public java.util.Set<AbstractCommand> getCommands()

A method to get all of the AbstractCommands registered with this CommandHandler

Returns:

All of the commands registered with this command handler.

Since:

1.0.1

findCommand

public AbstractCommand findCommand(java.lang.String trigger)

Method which attempts to find a AbstractCommand from the given trigger

Parameters:

trigger - The trigger of the command to find.

Returns:

The AbstractCommand that was found, sometimes null

Since:

1.0.0

execute

public void execute(AbstractCommand command,
                    T message,
                    java.lang.String args)

Method which attempts to execute the given AbstractCommand.

Parameters:

command - The AbstractCommand to execute.

message - The CommandHandler which triggered the command.

args - The arguments of the command.

Since:

1.0.0

findAndExecute

public void findAndExecute(java.lang.String trigger,
                           T message,
                           java.lang.String args)

A method which calls findCommand(String), and then #execute(AbstractCommand, T, String) if the found AbstractCommand is not null

Parameters:

trigger - The trigger of the command.

message - The CommandHandler which triggered the command.

args - The args of the command.

Since:

1.0.1

See Also:

findCommand(String), #execute(AbstractCommand, T, String)