org.anvilpowered.anvil.api.command

Interface CommandService<TCommandExecutor,TCommandSource>

public interface CommandService<TCommandExecutor,TCommandSource>

Method Summary

Modifier and Type	Method and Description
TCommandExecutor	generateHelpCommand(CommandNode<TCommandSource> node) Generates a help command for the provided CommandNode.
TCommandExecutor	generateReloadCommand()
default TCommandExecutor	generateRootCommand(java.lang.String helpUsage)
TCommandExecutor	generateRootCommand(java.lang.String helpUsage, java.util.function.Predicate<TCommandSource> extended)
TCommandExecutor	generateRoutingCommand(TCommandExecutor root, java.util.Map<java.util.List<java.lang.String>,TCommandExecutor> children, boolean childCommandFallback) Generates a command that runs a child command if its alias matches the first argument of the generated command.
default TCommandExecutor	generateVersionCommand(java.lang.String helpUsage)
TCommandExecutor	generateVersionCommand(java.lang.String helpUsage, java.util.function.Predicate<TCommandSource> extended)

Method Detail

generateRoutingCommand

TCommandExecutor generateRoutingCommand(@Nullable
                                        TCommandExecutor root,
                                        java.util.Map<java.util.List<java.lang.String>,TCommandExecutor> children,
                                        boolean childCommandFallback)

Generates a command that runs a child command if its alias matches the first argument of the generated command.

If childCommandFallback is false and the first argument does not match a child, a syntax error message will be shown to the source. Otherwise, the root command executor will run.

Parameters:

root - The command to run if no child was specified.

children - A map of child commands and their aliases.

childCommandFallback - whether to fall back to the root command if the first argument did not match a child command alias

Returns:

A routing command

Throws:

java.lang.UnsupportedOperationException - on Sponge. Use CommandSpec instead.

generateRootCommand

TCommandExecutor generateRootCommand(java.lang.String helpUsage,
                                     java.util.function.Predicate<TCommandSource> extended)

generateRootCommand

default TCommandExecutor generateRootCommand(java.lang.String helpUsage)

generateVersionCommand

TCommandExecutor generateVersionCommand(java.lang.String helpUsage,
                                        java.util.function.Predicate<TCommandSource> extended)

generateVersionCommand

default TCommandExecutor generateVersionCommand(java.lang.String helpUsage)

generateHelpCommand

TCommandExecutor generateHelpCommand(CommandNode<TCommandSource> node)

Generates a help command for the provided CommandNode.

Parameters:

node - The command node to return the HelpCommand for

Returns:

A help command for the provided CommandNode

generateReloadCommand

TCommandExecutor generateReloadCommand()

Returns:

A reload command