co.aikar.commands

Class BaseCommand

java.lang.Object

co.aikar.commands.BaseCommand

Direct Known Subclasses:

ForwardingCommand

public abstract class BaseCommand
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT
static String	UNKNOWN

Constructor Summary

Constructors

Constructor and Description
BaseCommand()
BaseCommand(String cmd)

Method Summary

Modifier and Type	Method and Description
boolean	canExecute(CommandIssuer issuer, RegisteredCommand<?> cmd)
void	doHelp(CommandIssuer issuer, String... args)
void	doHelp(Object issuer, String... args)
void	execute(CommandIssuer issuer, String commandLabel, String[] args)
CommandHelp	getCommandHelp() Deprecated. Unstable API
CommandIssuer	getCurrentCommandIssuer()
CommandManager	getCurrentCommandManager()
ExceptionHandler	getExceptionHandler()
String	getExecCommandLabel() Gets the root command name that the user actually typed
String	getExecSubcommand() Gets the actual sub command name the user typed
String	getName()
String[]	getOrigArgs() Gets the actual args in string form the user typed
boolean	hasPermission(CommandIssuer issuer)
boolean	hasPermission(Object issuer)
void	help(CommandIssuer issuer, String[] args)
void	help(Object issuer, String[] args)
BaseCommand	setExceptionHandler(ExceptionHandler exceptionHandler)
void	showCommandHelp() Deprecated. Unstable API
void	showSyntax(CommandIssuer issuer, RegisteredCommand<?> cmd)
List<String>	tabComplete(CommandIssuer issuer, String commandLabel, String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final String UNKNOWN

See Also:

Constant Field Values

DEFAULT

public static final String DEFAULT

See Also:

Constant Field Values

Constructor Detail

BaseCommand

public BaseCommand()

BaseCommand

public BaseCommand(String cmd)

Method Detail

getExecCommandLabel

public String getExecCommandLabel()

Gets the root command name that the user actually typed

Returns:

Name

getExecSubcommand

public String getExecSubcommand()

Gets the actual sub command name the user typed

Returns:

Name

getOrigArgs

public String[] getOrigArgs()

Gets the actual args in string form the user typed

Returns:

Args

execute

public void execute(CommandIssuer issuer,
                    String commandLabel,
                    String[] args)

getCurrentCommandIssuer

public CommandIssuer getCurrentCommandIssuer()

getCurrentCommandManager

public CommandManager getCurrentCommandManager()

canExecute

public boolean canExecute(CommandIssuer issuer,
                          RegisteredCommand<?> cmd)

tabComplete

public List<String> tabComplete(CommandIssuer issuer,
                                String commandLabel,
                                String[] args)
                         throws IllegalArgumentException

Throws:

IllegalArgumentException

getCommandHelp

@Deprecated
public CommandHelp getCommandHelp()

Deprecated. Unstable API

showCommandHelp

@Deprecated
public void showCommandHelp()

Deprecated. Unstable API

help

public void help(Object issuer,
                 String[] args)

help

public void help(CommandIssuer issuer,
                 String[] args)

doHelp

public void doHelp(Object issuer,
                   String... args)

doHelp

public void doHelp(CommandIssuer issuer,
                   String... args)

showSyntax

public void showSyntax(CommandIssuer issuer,
                       RegisteredCommand<?> cmd)

hasPermission

public boolean hasPermission(Object issuer)

hasPermission

public boolean hasPermission(CommandIssuer issuer)

getName

public String getName()

getExceptionHandler

public ExceptionHandler getExceptionHandler()

setExceptionHandler

public BaseCommand setExceptionHandler(ExceptionHandler exceptionHandler)