Uses of Interface
dev.sympho.modular_commands.api.command.Command
Packages that use Command
Package
Description
External interface through which client code can utilize the command system.
APIs related to defining a command.
Exceptions thrown by the system.
Registry system for registering commands that can be executed.
Runtime system for executing commands defined through the API.
Implementations for command contexts.
Default implementations for registries.
Collection of classes that provide assorted utilies for ease of use.
-
Uses of Command in dev.sympho.modular_commands.api
Methods in dev.sympho.modular_commands.api that return types with arguments of type CommandModifier and TypeMethodDescriptionCollection<Command<?>>
CommandGroup.commands()
Retrieves the commands contained in this group.Methods in dev.sympho.modular_commands.api with parameters of type CommandModifier and TypeMethodDescriptionstatic CommandGroup
Creates a command group from the given commands.Method parameters in dev.sympho.modular_commands.api with type arguments of type CommandModifier and TypeMethodDescriptionstatic CommandGroup
CommandGroup.of
(Collection<? extends Command<?>> commands) Creates a command group from the given commands. -
Uses of Command in dev.sympho.modular_commands.api.command
Methods in dev.sympho.modular_commands.api.command with parameters of type CommandModifier and TypeMethodDescriptionstatic <H extends @NonNull Handlers>
Command.Builder<H>Creates a new builder initialized with the properties of the given command. -
Uses of Command in dev.sympho.modular_commands.api.exception
Methods in dev.sympho.modular_commands.api.exception that return CommandModifier and TypeMethodDescriptionCommand<?>
IncompleteHandlingException.getCommand()
Retrieves the command that was invoked.Methods in dev.sympho.modular_commands.api.exception that return types with arguments of type CommandModifier and TypeMethodDescriptionIncompleteHandlingException.getExecutionChain()
Retrieves the command chain that was being executed.Constructors in dev.sympho.modular_commands.api.exception with parameters of type CommandModifierConstructorDescriptionInvalidChainException
(Command<?> command, Command<?> parent, String message) Creates a new instance.Constructor parameters in dev.sympho.modular_commands.api.exception with type arguments of type CommandModifierConstructorDescriptionIncompleteHandlingException
(List<? extends Command<?>> chain, Invocation invocation) Creates a new instance. -
Uses of Command in dev.sympho.modular_commands.api.registry
Methods in dev.sympho.modular_commands.api.registry that return CommandModifier and TypeMethodDescriptionRegistry.findCommand
(Invocation invocation, Class<H> type) Retrieves the best command known to this registry that has the given parent and name, and is compatible with the given type.Registry.getCommand
(String id) Retrieves the command with the given ID that is registered to this registry.Registry.removeCommand
(String id) Removes a command from this registry that was registered with the given ID.Methods in dev.sympho.modular_commands.api.registry that return types with arguments of type CommandModifier and TypeMethodDescription<H extends Handlers>
Collection<Command<? extends H>>Registry.getCommands
(Class<H> type) Retrieves all commands known to this registry that are compatible with the given type.Methods in dev.sympho.modular_commands.api.registry with parameters of type CommandModifier and TypeMethodDescriptionboolean
Registry.registerCommand
(Command<?> command) Registers a command into this registry.default void
Registry.registerCommands
(Command<?>... commands) Registers the given commands into this registry.Method parameters in dev.sympho.modular_commands.api.registry with type arguments of type CommandModifier and TypeMethodDescriptiondefault void
Registry.registerCommands
(Collection<? extends Command<?>> commands) Registers the given commands into this registry. -
Uses of Command in dev.sympho.modular_commands.execute
Methods in dev.sympho.modular_commands.execute with type parameters of type CommandModifier and TypeMethodDescriptionstatic <C extends Command<?>>
CInvocationUtils.getInvokedCommand
(List<? extends C> chain) Extracts the command being invoked from an execution chain.InvocationUtils.getSettingsSource
(List<C> chain) Determines the command in the execution chain that should provide the invocation settings.InvocationUtils.handlingOrder
(List<C> chain) Determines the sequence that command handlers should be invoked in for the given chain.Methods in dev.sympho.modular_commands.execute that return CommandModifier and TypeMethodDescriptionDetermines if a command has handlers compatible with the given type.Methods in dev.sympho.modular_commands.execute that return types with arguments of type CommandModifier and TypeMethodDescriptionstatic <H extends Handlers>
Tuple2<Invocation,List<Command<? extends H>>> InvocationUtils.parseInvocation
(Registry registry, SmartIterator<String> args, Class<H> commandType) Extracts an invocation from a sequence of args by performing lookups on the given registry, while building the corresponding execution chain.Methods in dev.sympho.modular_commands.execute with parameters of type CommandModifier and TypeMethodDescriptionDetermines if a command has handlers compatible with the given type.protected abstract CTX
PipelineBuilder.makeContext
(E event, Command<? extends H> command, Invocation invocation, I args) Creates a command context from a parsed invocation.Method parameters in dev.sympho.modular_commands.execute with type arguments of type CommandModifier and TypeMethodDescriptionInvocationUtils.accumulateGroups
(List<? extends Command<?>> chain) Determines the total set of groups required for an execution chain.InvocationValidator.validateAccess
(AccessValidator validator, List<? extends Command<?>> chain) Validates that the user that invoked a command has sufficient access to do so.InvocationValidator.validateSettings
(E event, List<? extends Command<?>> chain) Validates that a command invocation is appropriate as per the command's settings. -
Uses of Command in dev.sympho.modular_commands.impl.context
Fields in dev.sympho.modular_commands.impl.context declared as CommandModifier and TypeFieldDescriptionprotected final Command<?>
ContextImpl.command
The invoked command.Constructors in dev.sympho.modular_commands.impl.context with parameters of type CommandModifierConstructorDescriptionMessageContextImpl
(MessageCreateEvent event, Invocation invocation, Command<?> command, StringSplitter.Async.Iterator args, AccessValidator access) Initializes a new context. -
Uses of Command in dev.sympho.modular_commands.impl.registry
Methods in dev.sympho.modular_commands.impl.registry that return CommandModifier and TypeMethodDescriptionSimpleRegistry.findCommand
(Invocation invocation, Class<H> type) SimpleRegistry.getCommand
(String id) SimpleRegistry.removeCommand
(String id) Methods in dev.sympho.modular_commands.impl.registry that return types with arguments of type CommandModifier and TypeMethodDescription<H extends Handlers>
Collection<Command<? extends H>>SimpleRegistry.getCommands
(Class<H> type) Methods in dev.sympho.modular_commands.impl.registry with parameters of type Command -
Uses of Command in dev.sympho.modular_commands.utils
Methods in dev.sympho.modular_commands.utils with parameters of type CommandModifier and TypeMethodDescriptionstatic void
CommandUtils.validateCommand
(Command<?> command) Validates a command.