Package tech.guilhermekaua.spigotboot.commands.execution

Class CommandDispatcher

java.lang.Object

tech.guilhermekaua.spigotboot.commands.execution.CommandDispatcher

public class CommandDispatcher
extends Object

Constructor Summary

Constructors

Constructor	Description
CommandDispatcher(CommandParameterBinder parameterBinder, CommandInvocationExecutor invocationExecutor, CommandMessagesProvider messagesProvider, CompletionResolver completionResolver)	Creates a dispatcher with an empty interceptor chain and the default keyed-message renderer.
CommandDispatcher(CommandParameterBinder parameterBinder, CommandInvocationExecutor invocationExecutor, CommandMessagesProvider messagesProvider, CompletionResolver completionResolver, CommandInterceptorChain interceptorChain)	Creates a dispatcher with the given interceptor chain and the default keyed-message renderer.
CommandDispatcher(CommandParameterBinder parameterBinder, CommandInvocationExecutor invocationExecutor, CommandMessagesProvider messagesProvider, CompletionResolver completionResolver, CommandInterceptorChain interceptorChain, CommandMessageRenderer messageRenderer)	Creates a dispatcher with all collaborators supplied explicitly.

Method Summary

Modifier and Type	Method	Description
boolean	canUseAnyRoute(CompiledRootCommand root, CommandSenderHandle sender)	Returns whether the sender can use at least one route of the given root command — either the default handler or any subcommand route whose @Permission the sender satisfies (a route with no permission is always usable).
List<String>	complete(Context context, CompiledRootCommand root, CommandSenderHandle sender, String label, String[] args)
boolean	dispatch(Context context, CompiledRootCommand root, CommandSenderHandle sender, String label, String[] args)

Methods inherited from class java.lang.Object

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

Constructor Details

CommandDispatcher

public CommandDispatcher(CommandParameterBinder parameterBinder,
 CommandInvocationExecutor invocationExecutor,
 CommandMessagesProvider messagesProvider,
 CompletionResolver completionResolver)

Creates a dispatcher with an empty interceptor chain and the default keyed-message renderer. Convenience overload that delegates to CommandDispatcher(CommandParameterBinder, CommandInvocationExecutor, CommandMessagesProvider, CompletionResolver, CommandInterceptorChain, CommandMessageRenderer).

Parameters:

parameterBinder - binds raw input tokens to invocation arguments; must not be null

invocationExecutor - invokes the resolved command handler; must not be null

messagesProvider - resolves the active CommandMessages for a context; must not be null

completionResolver - produces tab-completion suggestions; must not be null

CommandDispatcher

public CommandDispatcher(CommandParameterBinder parameterBinder,
 CommandInvocationExecutor invocationExecutor,
 CommandMessagesProvider messagesProvider,
 CompletionResolver completionResolver,
 CommandInterceptorChain interceptorChain)

Creates a dispatcher with the given interceptor chain and the default keyed-message renderer. Convenience overload that delegates to CommandDispatcher(CommandParameterBinder, CommandInvocationExecutor, CommandMessagesProvider, CompletionResolver, CommandInterceptorChain, CommandMessageRenderer).

Parameters:

parameterBinder - binds raw input tokens to invocation arguments; must not be null

invocationExecutor - invokes the resolved command handler; must not be null

messagesProvider - resolves the active CommandMessages for a context; must not be null

completionResolver - produces tab-completion suggestions; must not be null

interceptorChain - the chain of interceptors run around each invocation; must not be null

CommandDispatcher

public CommandDispatcher(CommandParameterBinder parameterBinder,
 CommandInvocationExecutor invocationExecutor,
 CommandMessagesProvider messagesProvider,
 CompletionResolver completionResolver,
 CommandInterceptorChain interceptorChain,
 CommandMessageRenderer messageRenderer)

Creates a dispatcher with all collaborators supplied explicitly.

Parameters:

parameterBinder - binds raw input tokens to invocation arguments; must not be null

invocationExecutor - invokes the resolved command handler; must not be null

messagesProvider - resolves the active CommandMessages for a context; must not be null

completionResolver - produces tab-completion suggestions; must not be null

interceptorChain - the chain of interceptors run around each invocation; must not be null

messageRenderer - renders keyed CommandMessageException failures; must not be null

Throws:

NullPointerException - if any argument is null

Method Details

dispatch

public boolean dispatch(Context context,
 CompiledRootCommand root,
 CommandSenderHandle sender,
 String label,
 String[] args)

complete

public List<String> complete(Context context,
 CompiledRootCommand root,
 CommandSenderHandle sender,
 String label,
 String[] args)

canUseAnyRoute

public boolean canUseAnyRoute(CompiledRootCommand root,
 CommandSenderHandle sender)

Returns whether the sender can use at least one route of the given root command — either the default handler or any subcommand route whose @Permission the sender satisfies (a route with no permission is always usable). Platform adapters use this to gate command visibility (client-side tab completion / the command tree) so a command is hidden from senders who cannot run any of its routes, mirroring the per-route filtering complete(tech.guilhermekaua.spigotboot.core.context.Context, tech.guilhermekaua.spigotboot.commands.route.CompiledRootCommand, tech.guilhermekaua.spigotboot.commands.CommandSenderHandle, java.lang.String, java.lang.String[]) already applies to argument suggestions. The @CatchUnknown handler is intentionally not counted: it handles unmatched input rather than representing a usable command path.

Parameters:

root - the compiled root command; must not be null

sender - the sender to test; must not be null

Returns:

true if the default handler or at least one route is permitted for sender