Package revxrsal.commands.core

Class BaseCommandHandler

java.lang.Object

revxrsal.commands.core.BaseCommandHandler

All Implemented Interfaces:

CommandHandler

Direct Known Subclasses:

BukkitHandler, BungeeHandler, CLIHandler, JDAHandler, SpongeHandler, VelocityHandler

public class BaseCommandHandler
extends Object
implements CommandHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<CommandPath,revxrsal.commands.core.BaseCommandCategory>	categories
protected final Map<CommandPath,revxrsal.commands.core.CommandExecutable>	executables

Constructor Summary

Constructors

Constructor	Description
BaseCommandHandler()

Method Summary

Modifier and Type	Method	Description
@NotNull CommandHandler	accept(@NotNull CommandHandlerVisitor visitor)	Accepts the given CommandHandlerVisitor and allows it to visit this command handler.
@NotNull CommandHandler	disableStackTraceSanitizing()	Disables stacktrace sanitization.
<T> @NotNull Optional<@Nullable T>	dispatch(@NotNull CommandActor actor, @NotNull String commandInput)	Evaluates the command from the given input
<T> @NotNull Optional<@Nullable T>	dispatch(@NotNull CommandActor actor, @NotNull ArgumentStack arguments)	Evaluates the command from the given arguments
@NotNull CommandHandler	failOnTooManyArguments()	Sets the command to fail when too many arguments are specified in the command.
@NotNull ArgumentParser	getArgumentParser()	Returns the ArgumentParser responsible for controlling the logic of parsing strings.
@NotNull AutoCompleter	getAutoCompleter()	Returns the auto-completion handler of this command handler
@UnmodifiableView @NotNull Map<CommandPath,CommandCategory>	getCategories()	Returns an unmodifiable view of all the registered categories in this command handler.
CommandCategory	getCategory(@NotNull CommandPath path)	Returns the given CommandCategory that matches the given path.
ExecutableCommand	getCommand(@NotNull CommandPath path)	Returns the given ExecutableCommand that matches the given path.
@UnmodifiableView @NotNull Map<CommandPath,ExecutableCommand>	getCommands()	Returns an unmodifiable view of all the registered commands in this command handler.
<T> Supplier<T>	getDependency(@NotNull Class<T> dependencyType)	Returns the dependency registered for the given type
<T> Supplier<T>	getDependency(@NotNull Class<T> dependencyType, Supplier<T> def)	Returns the dependency registered for the given type, otherwise returns the given def value.
@NotNull CommandExceptionHandler	getExceptionHandler()	Returns the command exception handler currently used by this command handler
@NotNull String	getFlagPrefix()	Returns the prefix that comes before all Flag parameters when they are fetched from the command.
<T> CommandHelpWriter<T>	getHelpWriter()	Returns the CommandHelpWriter of this command handler.
@NotNull Locale	getLocale()	Gets the current, default locale used by this handler
@NotNull String	getMessagePrefix()	Returns the prefix that preceds all messages sent by CommandActor.reply(String) and CommandActor.error(String).
@NotNull MethodCallerFactory	getMethodCallerFactory()	Returns the MethodCallerFactory responsible for generating reflective calls.
Set<PermissionReader>	getPermissionReaders()
<T> ParameterResolver<T>	getResolver(CommandParameter parameter)
@NotNull Set<CommandPath>	getRootPaths()	Returns all the root commands or categories paths in this command handler.
@NotNull String	getSwitchPrefix()	Returns the prefix that comes before all Switch parameters when they are fetched from the command.
@NotNull Translator	getTranslator()	Returns the translator of this command handler
ArgumentStack	parseArguments(String... arguments)	Parses the string array and returns an ArgumentStack for it.
ArgumentStack	parseArgumentsForCompletion(String... arguments)	Parses the string and returns an ArgumentStack for it.
@NotNull CommandHandler	register(@NotNull Object... commands)	Registers the specified command from an instance.
<T extends Annotation> @NotNull CommandHandler	registerAnnotationReplacer(@NotNull Class<T> annotationType, @NotNull AnnotationReplacer<T> replacer)	Registers an annotation replacer.
@NotNull CommandHandler	registerCondition(@NotNull CommandCondition condition)	Registers the specified condition in which all commands will be validated with.
<T> @NotNull CommandHandler	registerContextResolver(int priority, @NotNull Class<T> type, @NotNull ContextResolver<T> resolver)	Registers a parameter resolver that gets its value from the command context.
<T> @NotNull CommandHandler	registerContextResolver(@NotNull Class<T> type, @NotNull ContextResolver<T> resolver)	Registers a parameter resolver that gets its value from the command context.
@NotNull CommandHandler	registerContextResolverFactory(int priority, @NotNull ContextResolverFactory factory)	Registers a ContextResolverFactory to this handler
@NotNull CommandHandler	registerContextResolverFactory(@NotNull ContextResolverFactory factory)	Registers a ContextResolverFactory to this handler
<T> @NotNull CommandHandler	registerContextValue(int priority, @NotNull Class<T> type, T value)	Registers a parameter type to always be a static value.
<T> @NotNull CommandHandler	registerContextValue(@NotNull Class<T> type, T value)	Registers a parameter type to always be a static value.
<T> @NotNull CommandHandler	registerDependency(@NotNull Class<T> type, @NotNull Supplier<T> supplier)	Registers a dependency for dependency injection.
<T> @NotNull CommandHandler	registerDependency(@NotNull Class<T> type, T value)	Registers a (static) dependency for dependency injection.
<T extends Throwable> @NotNull CommandHandler	registerExceptionHandler(@NotNull Class<T> exceptionType, @NotNull BiConsumer<CommandActor,T> handler)	Convenient method to register exception handlers.
<T> @NotNull CommandHandler	registerParameterValidator(@NotNull Class<T> type, @NotNull ParameterValidator<T> validator)	Registers a ParameterValidator for the specified parameter type.
@NotNull CommandHandler	registerPermissionReader(@NotNull PermissionReader reader)	Registers the given permission reader, which allows registering custom CommandPermission implementations with annotations.
<T> @NotNull CommandHandler	registerResponseHandler(@NotNull Class<T> responseType, @NotNull ResponseHandler<T> handler)	Registers a response handler for the specified response type.
@NotNull CommandHandler	registerSenderResolver(@NotNull SenderResolver resolver)	Registers the given sender resolver, which resolves parameters at index 0 that may be potentially a custom sender implementation.
<T> @NotNull CommandHandler	registerValueResolver(int priority, @NotNull Class<T> type, @NotNull ValueResolver<T> resolver)	Registers a parameter resolver that gets its value from the command arguments.
<T> @NotNull CommandHandler	registerValueResolver(@NotNull Class<T> type, @NotNull ValueResolver<T> resolver)	Registers a parameter resolver that gets its value from the command arguments.
@NotNull CommandHandler	registerValueResolverFactory(int priority, @NotNull ValueResolverFactory factory)	Registers a ValueResolverFactory to this handler
@NotNull CommandHandler	registerValueResolverFactory(@NotNull ValueResolverFactory factory)	Registers a ValueResolverFactory to this handler
<T extends Annotation> @Nullable List<Annotation>	replaceAnnotation(AnnotatedElement element, T ann)
BaseCommandHandler	setArgumentParser(@NotNull ArgumentParser argumentParser)	Sets the ArgumentParser responsible for controlling the logic of parsing strings.
protected void	setDependencies(Object ob)
@NotNull CommandHandler	setExceptionHandler(@NotNull CommandExceptionHandler handler)	Sets the CommandExceptionHandler to use for handling any exceptions that are thrown from the command.
@NotNull CommandHandler	setFlagPrefix(@NotNull String prefix)	Sets the prefix that all parameters annotated with Flag will be checked against.
<T> @NotNull CommandHandler	setHelpWriter(@NotNull CommandHelpWriter<T> helpWriter)	Sets the CommandHelpWriter responsible for generating help pages
void	setLocale(@NotNull Locale locale)	Sets the locale of this handler.
@NotNull CommandHandler	setMessagePrefix(@NotNull String prefix)	Returns the prefix that should preced all messages sent with CommandActor.reply(String) and CommandActor.error(String).
@NotNull CommandHandler	setMethodCallerFactory(@NotNull MethodCallerFactory factory)	Sets the MethodCallerFactory responsible for generating access to reflection methods.
@NotNull CommandHandler	setSwitchPrefix(@NotNull String prefix)	Sets the prefix that all parameters annotated with Switch will be checked against.
boolean	unregister(@NotNull String commandPath)	Unregisters the given path and all the sub-paths that belong to it
boolean	unregister(@NotNull CommandPath path)	Unregisters the given path and all the sub-paths that belong to it
void	unregisterAllCommands()	Unregisters all the command instances in this command handler.

Methods inherited from class java.lang.Object

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

Field Details

executables

protected final Map<CommandPath,revxrsal.commands.core.CommandExecutable> executables

categories

protected final Map<CommandPath,revxrsal.commands.core.BaseCommandCategory> categories

Constructor Details

BaseCommandHandler

public BaseCommandHandler()

Method Details

register

@NotNull
public @NotNull CommandHandler register(@NotNull
 @NotNull Object... commands)

Description copied from interface: CommandHandler

Registers the specified command from an instance. This will automatically set all Dependency-annotated fields with their values.

Specified by:

register in interface CommandHandler

Parameters:

commands - The commands object instances. Can be a class if methods are static.

Returns:

This command handler

getLocale

@NotNull
public @NotNull Locale getLocale()

Description copied from interface: CommandHandler

Gets the current, default locale used by this handler

Specified by:

getLocale in interface CommandHandler

Returns:

The default locale

setLocale

public void setLocale(@NotNull
 @NotNull Locale locale)

Description copied from interface: CommandHandler

Sets the locale of this handler.

Specified by:

setLocale in interface CommandHandler

Parameters:

locale - The locale of this handler

getTranslator

@NotNull
public @NotNull Translator getTranslator()

Description copied from interface: CommandHandler

Returns the translator of this command handler

Specified by:

getTranslator in interface CommandHandler

Returns:

The message translator

getPermissionReaders

public Set<PermissionReader> getPermissionReaders()

setMethodCallerFactory

@NotNull
public @NotNull CommandHandler setMethodCallerFactory(@NotNull
 @NotNull MethodCallerFactory factory)

Description copied from interface: CommandHandler

Sets the MethodCallerFactory responsible for generating access to reflection methods.

This method allows using alternative strategy for accessing methods reflectively.

Specified by:

setMethodCallerFactory in interface CommandHandler

Parameters:

factory - Factory to set

Returns:

This command handler

See Also:

• MethodCallerFactory

getArgumentParser

@NotNull
public @NotNull ArgumentParser getArgumentParser()

Description copied from interface: CommandHandler

Returns the ArgumentParser responsible for controlling the logic of parsing strings.

Specified by:

getArgumentParser in interface CommandHandler

Returns:

The argument parser.

parseArgumentsForCompletion

public ArgumentStack parseArgumentsForCompletion(String... arguments)
                                          throws ArgumentParseException

Description copied from interface: CommandHandler

Parses the string and returns an ArgumentStack for it. This method behaves exactly like CommandHandler.parseArguments(String[]), however it returns a singleton list of an empty string when the text is empty, suitable for auto-completion.

Specified by:

parseArgumentsForCompletion in interface CommandHandler

Parameters:

arguments - Strings to parse. These will get joined to a string separated by spaces.

Returns:

The argument stack.

Throws:

ArgumentParseException

parseArguments

public ArgumentStack parseArguments(String... arguments)
                             throws ArgumentParseException

Description copied from interface: CommandHandler

Parses the string array and returns an ArgumentStack for it.

Specified by:

parseArguments in interface CommandHandler

Parameters:

arguments - String array to parse. This will be joined as a single string with spaces.

Returns:

The argument stack.

Throws:

ArgumentParseException

See Also:

• ArgumentParser.parse(String)

setArgumentParser

public BaseCommandHandler setArgumentParser(@NotNull
 @NotNull ArgumentParser argumentParser)

Description copied from interface: CommandHandler

Sets the ArgumentParser responsible for controlling the logic of parsing strings.

Specified by:

setArgumentParser in interface CommandHandler

Parameters:

argumentParser - The argument parser to use.

Returns:

This command handler

setExceptionHandler

@NotNull
public @NotNull CommandHandler setExceptionHandler(@NotNull
 @NotNull CommandExceptionHandler handler)

Description copied from interface: CommandHandler

Sets the CommandExceptionHandler to use for handling any exceptions that are thrown from the command.

If not set, a default one will be used.

Specified by:

setExceptionHandler in interface CommandHandler

Parameters:

handler - The exception handler

Returns:

This command handler

See Also:

• CommandExceptionHandler.handleException(Throwable, CommandActor)

registerExceptionHandler

@NotNull
public <T extends Throwable>
@NotNull CommandHandler registerExceptionHandler(@NotNull
 @NotNull Class<T> exceptionType,
 @NotNull
 @NotNull BiConsumer<CommandActor,T> handler)

Description copied from interface: CommandHandler

Convenient method to register exception handlers. These will have higher priority over CommandExceptionHandler.

Specified by:

registerExceptionHandler in interface CommandHandler

Parameters:

exceptionType - The exception class

handler - The exception handler

Returns:

This command handler

See Also:

• CommandExceptionHandler.handleException(Throwable, CommandActor)

setSwitchPrefix

@NotNull
public @NotNull CommandHandler setSwitchPrefix(@NotNull
 @NotNull String prefix)

Description copied from interface: CommandHandler

Sets the prefix that all parameters annotated with Switch will be checked against. If not set,

-

will be used

Specified by:

setSwitchPrefix in interface CommandHandler

Parameters:

prefix - New prefix to set

Returns:

This command handler

setFlagPrefix

@NotNull
public @NotNull CommandHandler setFlagPrefix(@NotNull
 @NotNull String prefix)

Description copied from interface: CommandHandler

Sets the prefix that all parameters annotated with Flag will be checked against. If not set,

-

will be used

Specified by:

setFlagPrefix in interface CommandHandler

Parameters:

prefix - New prefix to set

Returns:

This command handler

setMessagePrefix

@NotNull
public @NotNull CommandHandler setMessagePrefix(@NotNull
 @NotNull String prefix)

Description copied from interface: CommandHandler

Returns the prefix that should preced all messages sent with CommandActor.reply(String) and CommandActor.error(String).

Note that the prefix will NOT be followed by spaces, it is your responsibility to include it in the prefix you set.

Specified by:

setMessagePrefix in interface CommandHandler

Parameters:

prefix - Message prefix

Returns:

This command handler

setHelpWriter

@NotNull
public <T> @NotNull CommandHandler setHelpWriter(@NotNull
 @NotNull CommandHelpWriter<T> helpWriter)

Description copied from interface: CommandHandler

Sets the CommandHelpWriter responsible for generating help pages

Specified by:

setHelpWriter in interface CommandHandler

Type Parameters:

T - The help entry type.

Parameters:

helpWriter - Help writer to use

Returns:

This command handler

See Also:

• CommandHelpWriter
• CommandHelp

disableStackTraceSanitizing

@NotNull
public @NotNull CommandHandler disableStackTraceSanitizing()

Description copied from interface: CommandHandler

Disables stacktrace sanitization.

By default, printed stack-trace is sanitized and stripped from internal, extra trace elements. This helps to keep the trace clean and readable, and removes away unnecessary paths. When disabled, full stacktrace will be printed.

Specified by:

disableStackTraceSanitizing in interface CommandHandler

Returns:

This command handler

failOnTooManyArguments

@NotNull
public @NotNull CommandHandler failOnTooManyArguments()

Description copied from interface: CommandHandler

Sets the command to fail when too many arguments are specified in the command.

Specified by:

failOnTooManyArguments in interface CommandHandler

Returns:

This command handler

See Also:

• TooManyArgumentsException

registerSenderResolver

@NotNull
public @NotNull CommandHandler registerSenderResolver(@NotNull
 @NotNull SenderResolver resolver)

Description copied from interface: CommandHandler

Registers the given sender resolver, which resolves parameters at index 0 that may be potentially a custom sender implementation.

See SenderResolver for more information.

Specified by:

registerSenderResolver in interface CommandHandler

Parameters:

resolver - Resolver to register

Returns:

This command handler

See Also:

• SenderResolver

registerPermissionReader

@NotNull
public @NotNull CommandHandler registerPermissionReader(@NotNull
 @NotNull PermissionReader reader)

Description copied from interface: CommandHandler

Registers the given permission reader, which allows registering custom CommandPermission implementations with annotations.

Specified by:

registerPermissionReader in interface CommandHandler

Parameters:

reader - Permission reader to register

Returns:

This command handler

See Also:

• PermissionReader

registerValueResolver

@NotNull
public <T> @NotNull CommandHandler registerValueResolver(@NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull ValueResolver<T> resolver)

Description copied from interface: CommandHandler

Registers a parameter resolver that gets its value from the command arguments.

See ValueResolver for more information

Specified by:

registerValueResolver in interface CommandHandler

Parameters:

type - The parameter type to resolve

resolver - The resolver

Returns:

This command handler

See Also:

• ValueResolver

registerValueResolver

@NotNull
public <T> @NotNull CommandHandler registerValueResolver(int priority,
 @NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull ValueResolver<T> resolver)

Description copied from interface: CommandHandler

Registers a parameter resolver that gets its value from the command arguments.

See ValueResolver for more information

Specified by:

registerValueResolver in interface CommandHandler

Parameters:

priority - The resolver priority. Zero represents the highest.

type - The parameter type to resolve

resolver - The resolver

Returns:

This command handler

See Also:

• ValueResolver

registerContextResolver

@NotNull
public <T> @NotNull CommandHandler registerContextResolver(@NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull ContextResolver<T> resolver)

Description copied from interface: CommandHandler

Registers a parameter resolver that gets its value from the command context.

See ContextResolver for more information

Specified by:

registerContextResolver in interface CommandHandler

Parameters:

type - The parameter type to resolve

resolver - The resolver

Returns:

This command handler

See Also:

• ContextResolver

registerContextResolver

@NotNull
public <T> @NotNull CommandHandler registerContextResolver(int priority,
 @NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull ContextResolver<T> resolver)

Description copied from interface: CommandHandler

Registers a parameter resolver that gets its value from the command context.

See ContextResolver for more information

Specified by:

registerContextResolver in interface CommandHandler

Parameters:

priority - The resolver priority. Zero represents the highest.

type - The parameter type to resolve

resolver - The resolver

Returns:

This command handler

See Also:

• ContextResolver

registerContextValue

@NotNull
public <T> @NotNull CommandHandler registerContextValue(@NotNull
 @NotNull Class<T> type,
 T value)

Description copied from interface: CommandHandler

Registers a parameter type to always be a static value. This is useful for registering singletons as parameters.

This is equivalent to calling registerContextResolver(type, ContextResolver.of(type))

See ContextResolver for more information

Specified by:

registerContextValue in interface CommandHandler

Parameters:

type - The parameter type to resolve

value - The value to retrun

Returns:

This command handler

See Also:

• ContextResolver

registerContextValue

@NotNull
public <T> @NotNull CommandHandler registerContextValue(int priority,
 @NotNull
 @NotNull Class<T> type,
 @NotNull
 T value)

Description copied from interface: CommandHandler

Registers a parameter type to always be a static value. This is useful for registering singletons as parameters.

This is equivalent to calling registerContextResolver(priority, type, ContextResolver.of(value))

See ContextResolver for more information

Specified by:

registerContextValue in interface CommandHandler

Parameters:

priority - The resolver priority. Zero represents the highest.

type - The parameter type to resolve

value - The value to retrun

Returns:

This command handler

See Also:

• ContextResolver

registerValueResolverFactory

@NotNull
public @NotNull CommandHandler registerValueResolverFactory(@NotNull
 @NotNull ValueResolverFactory factory)

Description copied from interface: CommandHandler

Registers a ValueResolverFactory to this handler

Specified by:

registerValueResolverFactory in interface CommandHandler

Parameters:

factory - Factory to register

Returns:

This command handler

See Also:

• ValueResolverFactory
• CommandHandler.registerContextResolverFactory(ContextResolverFactory)

registerValueResolverFactory

@NotNull
public @NotNull CommandHandler registerValueResolverFactory(int priority,
 @NotNull
 @NotNull ValueResolverFactory factory)

Description copied from interface: CommandHandler

Registers a ValueResolverFactory to this handler

Specified by:

registerValueResolverFactory in interface CommandHandler

Parameters:

priority - The resolver priority. Zero represents the highest.

factory - Factory to register

Returns:

This command handler

See Also:

• ValueResolverFactory
• CommandHandler.registerContextResolverFactory(ContextResolverFactory)

registerContextResolverFactory

@NotNull
public @NotNull CommandHandler registerContextResolverFactory(@NotNull
 @NotNull ContextResolverFactory factory)

Description copied from interface: CommandHandler

Registers a ContextResolverFactory to this handler

Specified by:

registerContextResolverFactory in interface CommandHandler

Parameters:

factory - Factory to register

Returns:

This command handler

See Also:

• ContextResolverFactory
• CommandHandler.registerValueResolverFactory(ValueResolverFactory)

registerContextResolverFactory

@NotNull
public @NotNull CommandHandler registerContextResolverFactory(int priority,
 @NotNull
 @NotNull ContextResolverFactory factory)

Description copied from interface: CommandHandler

Registers a ContextResolverFactory to this handler

Specified by:

registerContextResolverFactory in interface CommandHandler

Parameters:

priority - The resolver priority. Zero represents the highest.

factory - Factory to register

Returns:

This command handler

See Also:

• ContextResolverFactory
• CommandHandler.registerValueResolverFactory(ValueResolverFactory)

registerCondition

@NotNull
public @NotNull CommandHandler registerCondition(@NotNull
 @NotNull CommandCondition condition)

Description copied from interface: CommandHandler

Registers the specified condition in which all commands will be validated with.

Specified by:

registerCondition in interface CommandHandler

Parameters:

condition - Condition to register

Returns:

This command handler

registerDependency

@NotNull
public <T> @NotNull CommandHandler registerDependency(@NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull Supplier<T> supplier)

Description copied from interface: CommandHandler

Registers a dependency for dependency injection.

Any fields in the command class or instance with the Dependency annotation will have their value set from this supplier.

Specified by:

registerDependency in interface CommandHandler

Type Parameters:

T - The dependency type

Parameters:

type - The dependency class type. This must match the field type.

supplier - The dependency supplier

Returns:

This command handler

See Also:

• CommandHandler.registerDependency(Class, Object)

registerDependency

@NotNull
public <T> @NotNull CommandHandler registerDependency(@NotNull
 @NotNull Class<T> type,
 T value)

Description copied from interface: CommandHandler

Registers a (static) dependency for dependency injection.

Any fields in the command class or instance with the Dependency annotation will have their value set to this value.

Specified by:

registerDependency in interface CommandHandler

Type Parameters:

T - The dependency type

Parameters:

type - The dependency class type. This must match the field type

value - The dependency value

Returns:

This command handler

See Also:

• CommandHandler.registerDependency(Class, Supplier)

registerParameterValidator

@NotNull
public <T> @NotNull CommandHandler registerParameterValidator(@NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull ParameterValidator<T> validator)

Description copied from interface: CommandHandler

Registers a ParameterValidator for the specified parameter type. Parameter validators can access all information about a parameter, including the name and annotations.

Specified by:

registerParameterValidator in interface CommandHandler

Type Parameters:

T - The parameter type

Parameters:

type - The parameter type

validator - The validator for this parameter

Returns:

This command handler

registerResponseHandler

@NotNull
public <T> @NotNull CommandHandler registerResponseHandler(@NotNull
 @NotNull Class<T> responseType,
 @NotNull
 @NotNull ResponseHandler<T> handler)

Description copied from interface: CommandHandler

Registers a response handler for the specified response type. Response handlers do post-handling with results returned from command methods.

Note that response handlers are captured by ExecutableCommands when they are registered, so they should be registered before the command itself is registered.

Specified by:

registerResponseHandler in interface CommandHandler

Type Parameters:

T - The response type

Parameters:

responseType - The response class

handler - The response handler implementation

Returns:

This command handler

registerAnnotationReplacer

@NotNull
public <T extends Annotation>
@NotNull CommandHandler registerAnnotationReplacer(@NotNull
 @NotNull Class<T> annotationType,
 @NotNull
 @NotNull AnnotationReplacer<T> replacer)

Description copied from interface: CommandHandler

Registers an annotation replacer. Annotation replacers allow to dynamically generate annotations at runtime using APIs such as Annotations.

Specified by:

registerAnnotationReplacer in interface CommandHandler

accept

@NotNull
public @NotNull CommandHandler accept(@NotNull
 @NotNull CommandHandlerVisitor visitor)

Description copied from interface: CommandHandler

Accepts the given CommandHandlerVisitor and allows it to visit this command handler.

Specified by:

accept in interface CommandHandler

Parameters:

visitor - Visitor to accept

Returns:

This command handler

See Also:

• CommandHandlerVisitor

replaceAnnotation

@Nullable
public <T extends Annotation>
@Nullable List<Annotation> replaceAnnotation(AnnotatedElement element,
 T ann)

getAutoCompleter

@NotNull
public @NotNull AutoCompleter getAutoCompleter()

Description copied from interface: CommandHandler

Returns the auto-completion handler of this command handler

Specified by:

getAutoCompleter in interface CommandHandler

Returns:

The auto-completion handler

getCommand

public ExecutableCommand getCommand(@NotNull
 @NotNull CommandPath path)

Description copied from interface: CommandHandler

Returns the given ExecutableCommand that matches the given path. This can return null if no command exists at such a path.

Note that CommandPaths are, by default, case-insensitive.

Specified by:

getCommand in interface CommandHandler

Parameters:

path - Path to look for

Returns:

The command at the given path

getCategory

public CommandCategory getCategory(@NotNull
 @NotNull CommandPath path)

Description copied from interface: CommandHandler

Returns the given CommandCategory that matches the given path. This can return null if no category exists at such a path.

Note that CommandPaths are, by default, case-insensitive.

Specified by:

getCategory in interface CommandHandler

Parameters:

path - Path to look for

Returns:

The category at the given path

getCommands

@NotNull
public @UnmodifiableView @NotNull Map<CommandPath,ExecutableCommand> getCommands()

Description copied from interface: CommandHandler

Returns an unmodifiable view of all the registered commands in this command handler.

Specified by:

getCommands in interface CommandHandler

Returns:

The registered commands

getCategories

@NotNull
public @UnmodifiableView @NotNull Map<CommandPath,CommandCategory> getCategories()

Description copied from interface: CommandHandler

Returns an unmodifiable view of all the registered categories in this command handler.

Specified by:

getCategories in interface CommandHandler

Returns:

The registered categories

getResolver

public <T> ParameterResolver<T> getResolver(CommandParameter parameter)

getExceptionHandler

@NotNull
public @NotNull CommandExceptionHandler getExceptionHandler()

Description copied from interface: CommandHandler

Returns the command exception handler currently used by this command handler

Specified by:

getExceptionHandler in interface CommandHandler

Returns:

The command exception handler

getMethodCallerFactory

@NotNull
public @NotNull MethodCallerFactory getMethodCallerFactory()

Description copied from interface: CommandHandler

Returns the MethodCallerFactory responsible for generating reflective calls.

Specified by:

getMethodCallerFactory in interface CommandHandler

Returns:

The method caller factory

getHelpWriter

public <T> CommandHelpWriter<T> getHelpWriter()

Description copied from interface: CommandHandler

Returns the CommandHelpWriter of this command handler. This can be null if no writer is registered.

Specified by:

getHelpWriter in interface CommandHandler

Type Parameters:

T - Command help entries type

Returns:

The help writer of this handler

unregister

public boolean unregister(@NotNull
 @NotNull CommandPath path)

Description copied from interface: CommandHandler

Unregisters the given path and all the sub-paths that belong to it

Specified by:

unregister in interface CommandHandler

Parameters:

path - Path to unregister

Returns:

True if one or more elements were removed by this call.

unregister

public boolean unregister(@NotNull
 @NotNull String commandPath)

Description copied from interface: CommandHandler

Unregisters the given path and all the sub-paths that belong to it

Specified by:

unregister in interface CommandHandler

Parameters:

commandPath - Path to unregister

Returns:

True if one or more elements were removed by this call.

unregisterAllCommands

public void unregisterAllCommands()

Description copied from interface: CommandHandler

Unregisters all the command instances in this command handler.

Specified by:

unregisterAllCommands in interface CommandHandler

getRootPaths

@NotNull
public @NotNull Set<CommandPath> getRootPaths()

Description copied from interface: CommandHandler

Returns all the root commands or categories paths in this command handler.

Specified by:

getRootPaths in interface CommandHandler

Returns:

All root command paths

getSwitchPrefix

@NotNull
public @NotNull String getSwitchPrefix()

Description copied from interface: CommandHandler

Returns the prefix that comes before all Switch parameters when they are fetched from the command.

Specified by:

getSwitchPrefix in interface CommandHandler

Returns:

The switch prefix

getFlagPrefix

@NotNull
public @NotNull String getFlagPrefix()

Description copied from interface: CommandHandler

Returns the prefix that comes before all Flag parameters when they are fetched from the command.

Specified by:

getFlagPrefix in interface CommandHandler

Returns:

The switch prefix

getMessagePrefix

@NotNull
public @NotNull String getMessagePrefix()

Description copied from interface: CommandHandler

Returns the prefix that preceds all messages sent by CommandActor.reply(String) and CommandActor.error(String).

Set with CommandHandler.setMessagePrefix(String)

Specified by:

getMessagePrefix in interface CommandHandler

Returns:

The message prefix

dispatch

@NotNull
public <T> @NotNull Optional<@Nullable T> dispatch(@NotNull
 @NotNull CommandActor actor,
 @NotNull
 @NotNull ArgumentStack arguments)

Description copied from interface: CommandHandler

Evaluates the command from the given arguments

Specified by:

dispatch in interface CommandHandler

Parameters:

actor - Actor to execute as

arguments - Arguments to invoke the command with

Returns:

The result returned from invoking the command method. The optional value may be null if an exception was thrown.

dispatch

@NotNull
public <T> @NotNull Optional<@Nullable T> dispatch(@NotNull
 @NotNull CommandActor actor,
 @NotNull
 @NotNull String commandInput)

Description copied from interface: CommandHandler

Evaluates the command from the given input

Specified by:

dispatch in interface CommandHandler

Parameters:

actor - Actor to execute as

commandInput - Input to invoke with

getDependency

public <T> Supplier<T> getDependency(@NotNull
 @NotNull Class<T> dependencyType)

Description copied from interface: CommandHandler

Returns the dependency registered for the given type

Specified by:

getDependency in interface CommandHandler

Type Parameters:

T - Dependency type

Parameters:

dependencyType - Dependency type to look for

Returns:

The dependency, or null if not found.

getDependency

public <T> Supplier<T> getDependency(@NotNull
 @NotNull Class<T> dependencyType,
 Supplier<T> def)

Description copied from interface: CommandHandler

Returns the dependency registered for the given type, otherwise returns the given def value.

Specified by:

getDependency in interface CommandHandler

Type Parameters:

T - Dependency type

Parameters:

dependencyType - Dependency type to look for

def - Default value if no dependency is registered for the given type.

Returns:

The dependency, or null if not found.

setDependencies

protected void setDependencies(Object ob)