org.enginehub.piston

Interface CommandManager

All Superinterfaces:

ArgumentConverterAccess, ArgumentConverterStore

public interface CommandManager
extends ArgumentConverterStore

Responsible for holding all commands, as well as parsing and dispatching from user input.

Field Summary

Fields inherited from interface org.enginehub.piston.converter.ArgumentConverterAccess

EMPTY

Method Summary

Modifier and Type	Method and Description
default boolean	containsCommand(java.lang.String name) Determine if this manager knows of a command with name name.
default int	execute(InjectedValueAccess context, java.util.List<java.lang.String> args) Execute a command, given a set of arguments and a context.
java.util.stream.Stream<Command>	getAllCommands() Retrieve all commands that are registered.
java.util.Optional<Command>	getCommand(java.lang.String name) Get the command with name name, if registered.
com.google.common.collect.ImmutableSet<Suggestion>	getSuggestions(InjectedValueAccess context, java.util.List<java.lang.String> args) Suggest inputs based on a current user input.
Command.Builder	newCommand(java.lang.String name) Create a new command builder, using the default implementation of this manager.
CommandParseResult	parse(InjectedValueAccess context, java.util.List<java.lang.String> args) Parse a command, given a set of arguments and a context.
void	register(Command command) Registers any command, regardless of how it came about.
default void	register(java.lang.String name, java.util.function.Consumer<Command.Builder> registrationProcess) Register a command that initially has the given name, and then is configured by a function.
default void	registerManager(CommandManager manager) Register an entire manager with this one, inheriting all of its commands.

Methods inherited from interface org.enginehub.piston.converter.ArgumentConverterStore

registerConverter, registerConverters

Methods inherited from interface org.enginehub.piston.converter.ArgumentConverterAccess

getConverter, keySet

Method Detail

newCommand

Command.Builder newCommand(java.lang.String name)

Create a new command builder, using the default implementation of this manager.

This does not register the command.

Returns:

the new command

register

void register(Command command)

Registers any command, regardless of how it came about.

Use this if you do not want to use the default command implementation of this manager.

Parameters:

command - the command to register

register

default void register(java.lang.String name,
                      java.util.function.Consumer<Command.Builder> registrationProcess)

Register a command that initially has the given name, and then is configured by a function.

Parameters:

name - the name of the command

registrationProcess - a function that will build the command

registerManager

default void registerManager(CommandManager manager)

Register an entire manager with this one, inheriting all of its commands.

getAllCommands

java.util.stream.Stream<Command> getAllCommands()

Retrieve all commands that are registered.

containsCommand

default boolean containsCommand(java.lang.String name)

Determine if this manager knows of a command with name name.

Includes aliases.

Parameters:

name - the name to check

Returns:

true if a command has this name, either primarily or by alias

getCommand

java.util.Optional<Command> getCommand(java.lang.String name)

Get the command with name name, if registered.

Includes aliases.

Parameters:

name - the name to check

Returns:

Optional.of(Object) the command if registered, otherwise Optional.empty()

getSuggestions

com.google.common.collect.ImmutableSet<Suggestion> getSuggestions(InjectedValueAccess context,
                                                                  java.util.List<java.lang.String> args)

Suggest inputs based on a current user input. This input should be the entire command line, so that partial parsing may occur.

Parameters:

context - the injected value context

args - the command line to suggest into

Returns:

the suggestions

parse

CommandParseResult parse(InjectedValueAccess context,
                         java.util.List<java.lang.String> args)

Parse a command, given a set of arguments and a context.

Argument zero is the command name, without any leading slash. The rest of the arguments will be parsed into the correct parts.

Note: Command conditions must pass when encountered, e.g. the root command condition will be tested before parsing its arguments. This is to ensure no information is leaked about sub-commands, etc. while parsing. This also means that there is no need to validate conditions after calling this method, unless you wish to use a different context.

Parameters:

context - the injected value context

args - the arguments to include

Returns:

the parsing output

execute

default int execute(InjectedValueAccess context,
                    java.util.List<java.lang.String> args)

Execute a command, given a set of arguments and a context.

Argument zero is the command name, without any leading slash. The rest of the arguments will be parsed into the correct parts.

Parameters:

context - the injected value context

args - the arguments to include

Returns:

the count from the executed command