me.piggypiglet.framework.commands.framework

Class Command<T extends User>

java.lang.Object

me.piggypiglet.framework.commands.framework.Command<T>

Direct Known Subclasses:

BaseCommand, GenericMinecraftCommand, HelpCommand, StopCommand

public abstract class Command<T extends User>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Command.Options

Field Summary

Fields

Modifier and Type	Field and Description
protected Command.Options	options Configure options for this command.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Command(java.lang.String prefix)

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	execute(T user, java.lang.String[] args)
java.lang.String	getCommand()
java.lang.String	getDescription()
protected java.lang.String	getHandler()
java.util.List<java.lang.String>	getHandlers()
java.util.List<java.lang.String>	getPermissions()
java.lang.String	getUsage()
boolean	isDefault()
boolean	run(T user, java.lang.String[] args, java.lang.String handler)

Methods inherited from class java.lang.Object

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

Field Detail

options

protected Command.Options options

Configure options for this command.

Constructor Detail

Command

protected Command(java.lang.String prefix)

Method Detail

execute

protected abstract boolean execute(T user,
                                   java.lang.String[] args)

Parameters:

user - Wrapper for any sort of user interaction

args - Message, excluding the prefix and command, split via space. Multiple word arguments can be achieved by using double quotes in the user's input. For example, test "multi word" would only be two arguments.

Returns:

Whether the command's usage method should be sent or not. Returning false will send the message.

run

public boolean run(T user,
                   java.lang.String[] args,
                   java.lang.String handler)

getCommand

public java.lang.String getCommand()

getHandlers

public java.util.List<java.lang.String> getHandlers()

getDescription

public java.lang.String getDescription()

getUsage

public java.lang.String getUsage()

getPermissions

public java.util.List<java.lang.String> getPermissions()

isDefault

public boolean isDefault()

getHandler

protected java.lang.String getHandler()