co.aikar.commands

Class CommandManager<I,FT,F extends MessageFormatter<FT>>

java.lang.Object

co.aikar.commands.CommandManager<I,FT,F>

public abstract class CommandManager<I,FT,F extends MessageFormatter<FT>>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ExceptionHandler	defaultExceptionHandler
protected F	defaultFormatter
protected Map<MessageType,F>	formatters
protected CommandReplacements	replacements
protected Map<String,co.aikar.commands.RootCommand>	rootCommands
protected Set<Locale>	supportedLanguages

Constructor Summary

Constructors

Constructor and Description
CommandManager()

Method Summary

Modifier and Type	Method and Description
void	addSupportedLanguage(Locale locale) Adds a new locale to the list of automatic Locales to load Message Bundles for.
abstract <R extends CommandExecutionContext> R	createCommandContext(RegisteredCommand command, Parameter parameter, CommandIssuer sender, List<String> args, int i, Map<String,Object> passedArgs)
CommandOperationContext	createCommandOperationContext(BaseCommand command, CommandIssuer issuer, String commandLabel, String[] args)
abstract CommandCompletionContext	createCompletionContext(RegisteredCommand command, CommandIssuer sender, String input, String config, String[] args)
RegisteredCommand	createRegisteredCommand(BaseCommand command, String cmdName, Method method, String prefSubCommand)
abstract co.aikar.commands.RootCommand	createRootCommand(String cmd)
void	enableUnstableAPI(String api) Deprecated. Use this with caution! If you enable and use Unstable API's, your next compile using ACF may require you to update your implementation to those unstable API's
String	formatMessage(CommandIssuer issuer, MessageType type, co.aikar.locales.MessageKeyProvider key, String... replacements)
CommandHelp	generateCommandHelp() Deprecated. Unstable API
CommandHelp	generateCommandHelp(CommandIssuer issuer, co.aikar.commands.RootCommand rootCommand) Deprecated. Unstable API
CommandHelp	generateCommandHelp(CommandIssuer issuer, @NotNull String command) Deprecated. Unstable API
CommandHelp	generateCommandHelp(@NotNull String command) Deprecated. Unstable API
abstract CommandCompletions<?>	getCommandCompletions() Gets the command completions manager
abstract CommandContexts<?>	getCommandContexts() Gets the command contexts manager
abstract CommandIssuer	getCommandIssuer(Object issuer)
CommandReplacements	getCommandReplacements() Lets you add custom string replacements that can be applied to annotation values, to reduce duplication/repetition of common values such as permission nodes and command prefixes.
static CommandIssuer	getCurrentCommandIssuer()
static CommandManager	getCurrentCommandManager()
static CommandOperationContext	getCurrentCommandOperationContext()
ExceptionHandler	getDefaultExceptionHandler() Gets the current default exception handler, might be null.
F	getDefaultFormatter()
F	getFormat(MessageType type)
Locale	getIssuerLocale(CommandIssuer issuer)
abstract Locales	getLocales() Returns a Locales Manager to add and modify language tables for your commands.
Set<Locale>	getSupportedLanguages() Gets a list of all currently supported languages for this manager.
protected boolean	handleUncaughtException(BaseCommand scope, RegisteredCommand registeredCommand, CommandIssuer sender, List<String> args, Throwable t)
boolean	hasPermission(CommandIssuer issuer, String permission)
abstract boolean	hasRegisteredCommands()
abstract boolean	isCommandIssuer(Class<?> type)
void	log(co.aikar.commands.LogLevel level, String message)
abstract void	log(co.aikar.commands.LogLevel level, String message, Throwable throwable)
co.aikar.commands.RootCommand	obtainRootCommand(String cmd)
abstract void	registerCommand(BaseCommand command) Registers a command with ACF
void	sendMessage(CommandIssuer issuer, MessageType type, co.aikar.locales.MessageKeyProvider key, String... replacements)
void	sendMessage(I issuerArg, MessageType type, co.aikar.locales.MessageKeyProvider key, String... replacements)
void	setDefaultExceptionHandler(ExceptionHandler exceptionHandler) Sets the default ExceptionHandler that is called when an exception occurs while executing a command, if the command doesn't have it's own exception handler registered.
void	setDefaultFormatter(F defaultFormatter)
F	setFormat(MessageType type, F formatter)
void	setFormat(MessageType type, FT... colors)
void	setFormat(MessageType type, int i, FT color)

Methods inherited from class java.lang.Object

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

Field Detail

rootCommands

protected Map<String,co.aikar.commands.RootCommand> rootCommands

replacements

protected CommandReplacements replacements

defaultExceptionHandler

protected ExceptionHandler defaultExceptionHandler

supportedLanguages

protected Set<Locale> supportedLanguages

formatters

protected Map<MessageType,F extends MessageFormatter<FT>> formatters

defaultFormatter

protected F extends MessageFormatter<FT> defaultFormatter

Constructor Detail

CommandManager

public CommandManager()

Method Detail

getCurrentCommandOperationContext

public static CommandOperationContext getCurrentCommandOperationContext()

getCurrentCommandIssuer

public static CommandIssuer getCurrentCommandIssuer()

getCurrentCommandManager

public static CommandManager getCurrentCommandManager()

setFormat

public F setFormat(MessageType type,
                   F formatter)

getFormat

public F getFormat(MessageType type)

setFormat

public void setFormat(MessageType type,
                      FT... colors)

setFormat

public void setFormat(MessageType type,
                      int i,
                      FT color)

getDefaultFormatter

public F getDefaultFormatter()

setDefaultFormatter

public void setDefaultFormatter(F defaultFormatter)

getCommandContexts

public abstract CommandContexts<?> getCommandContexts()

Gets the command contexts manager

Returns:

Command Contexts

getCommandCompletions

public abstract CommandCompletions<?> getCommandCompletions()

Gets the command completions manager

Returns:

Command Completions

generateCommandHelp

@Deprecated
public CommandHelp generateCommandHelp(@NotNull
                                                   @NotNull String command)

Deprecated. Unstable API

generateCommandHelp

@Deprecated
public CommandHelp generateCommandHelp(CommandIssuer issuer,
                                                   @NotNull
                                                   @NotNull String command)

Deprecated. Unstable API

generateCommandHelp

@Deprecated
public CommandHelp generateCommandHelp()

Deprecated. Unstable API

generateCommandHelp

@Deprecated
public CommandHelp generateCommandHelp(CommandIssuer issuer,
                                                   co.aikar.commands.RootCommand rootCommand)

Deprecated. Unstable API

registerCommand

public abstract void registerCommand(BaseCommand command)

Registers a command with ACF

Parameters:

command - The command to register

hasRegisteredCommands

public abstract boolean hasRegisteredCommands()

isCommandIssuer

public abstract boolean isCommandIssuer(Class<?> type)

getCommandIssuer

public abstract CommandIssuer getCommandIssuer(Object issuer)

createRootCommand

public abstract co.aikar.commands.RootCommand createRootCommand(String cmd)

getLocales

public abstract Locales getLocales()

Returns a Locales Manager to add and modify language tables for your commands.

Returns:

createCommandContext

public abstract <R extends CommandExecutionContext> R createCommandContext(RegisteredCommand command,
                                                                           Parameter parameter,
                                                                           CommandIssuer sender,
                                                                           List<String> args,
                                                                           int i,
                                                                           Map<String,Object> passedArgs)

createCompletionContext

public abstract CommandCompletionContext createCompletionContext(RegisteredCommand command,
                                                                 CommandIssuer sender,
                                                                 String input,
                                                                 String config,
                                                                 String[] args)

log

public abstract void log(co.aikar.commands.LogLevel level,
                         String message,
                         Throwable throwable)

log

public void log(co.aikar.commands.LogLevel level,
                String message)

getCommandReplacements

public CommandReplacements getCommandReplacements()

Lets you add custom string replacements that can be applied to annotation values, to reduce duplication/repetition of common values such as permission nodes and command prefixes. Any replacement registered starts with a % So for ex @CommandPermission("%staff")

Returns:

Replacements Manager

hasPermission

public boolean hasPermission(CommandIssuer issuer,
                             String permission)

obtainRootCommand

public co.aikar.commands.RootCommand obtainRootCommand(String cmd)

createRegisteredCommand

public RegisteredCommand createRegisteredCommand(BaseCommand command,
                                                 String cmdName,
                                                 Method method,
                                                 String prefSubCommand)

setDefaultExceptionHandler

public void setDefaultExceptionHandler(ExceptionHandler exceptionHandler)

Sets the default ExceptionHandler that is called when an exception occurs while executing a command, if the command doesn't have it's own exception handler registered.

Parameters:

exceptionHandler - the handler that should handle uncaught exceptions

getDefaultExceptionHandler

public ExceptionHandler getDefaultExceptionHandler()

Gets the current default exception handler, might be null.

Returns:

the default exception handler

handleUncaughtException

protected boolean handleUncaughtException(BaseCommand scope,
                                          RegisteredCommand registeredCommand,
                                          CommandIssuer sender,
                                          List<String> args,
                                          Throwable t)

sendMessage

public void sendMessage(I issuerArg,
                        MessageType type,
                        co.aikar.locales.MessageKeyProvider key,
                        String... replacements)

sendMessage

public void sendMessage(CommandIssuer issuer,
                        MessageType type,
                        co.aikar.locales.MessageKeyProvider key,
                        String... replacements)

formatMessage

public String formatMessage(CommandIssuer issuer,
                            MessageType type,
                            co.aikar.locales.MessageKeyProvider key,
                            String... replacements)

getIssuerLocale

public Locale getIssuerLocale(CommandIssuer issuer)

createCommandOperationContext

public CommandOperationContext createCommandOperationContext(BaseCommand command,
                                                             CommandIssuer issuer,
                                                             String commandLabel,
                                                             String[] args)

getSupportedLanguages

public Set<Locale> getSupportedLanguages()

Gets a list of all currently supported languages for this manager. These locales will be automatically loaded from

Returns:

addSupportedLanguage

public void addSupportedLanguage(Locale locale)

Adds a new locale to the list of automatic Locales to load Message Bundles for. All bundles loaded under the previous supported languages will now automatically load for this new locale too.

Parameters:

locale -

enableUnstableAPI

@Deprecated
public void enableUnstableAPI(String api)

Deprecated. Use this with caution! If you enable and use Unstable API's, your next compile using ACF may require you to update your implementation to those unstable API's