Package io.github.mqzn.commands.base.manager

Class AbstractCommandManager<P,S>

java.lang.Object

io.github.mqzn.commands.base.manager.AbstractCommandManager<P,S>

Type Parameters:

P - The bootstrap for the lib to work on

S - The command sender type

All Implemented Interfaces:

CommandManager<P,S>

public abstract class AbstractCommandManager<P,S>
extends Object
implements CommandManager<P,S>

The class responsible for handling, registering, and coordinating the execution of the available commands

See Also:

• CommandManager

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull io.github.mqzn.commands.base.manager.ArgumentNumberSuggestionProcessor	argumentNumberSuggestionProcessor
protected final P	bootstrap
protected final @NotNull CaptionRegistry<S>	captionRegistry
protected final Logger	logger
protected final @NotNull SenderProviderRegistry<S>	senderProviderRegistry
protected final @NotNull SenderWrapper<S>	wrapper

Constructor Summary

Constructors

Constructor	Description
AbstractCommandManager(P bootstrap, @NotNull SenderWrapper<S> wrapper)
AbstractCommandManager(P bootstrap, @NotNull SenderWrapper<S> wrapper, CommandExecutionCoordinator.Type coordinator)

Method Summary

Modifier and Type	Method	Description
@NotNull CaptionRegistry<S>	captionRegistry()
@NotNull CommandExceptionHandler<S>	exceptionHandler()
final <C> void	executeCommand(@NotNull Command<S> command, S sender, @NotNull String[] args)
@NotNull List<CommandSyntax<S>>	findAmbiguity(@NotNull List<CommandSyntax<S>> syntaxes)
@Nullable CommandSyntax<S>	findSyntax(@NotNull Command<S> command, @NotNull DelegateCommandContext<S> commandContext)
@NotNull FlagRegistry	flagRegistry()
P	getBootstrap()
@Nullable Command<S>	getCommand(String name)
@NotNull Collection<Command<S>>	getCommands()
@NotNull SenderWrapper<S>	getSenderWrapper()
void	handleHelpProvider(S sender, @NotNull Context<S> context, @NotNull String label, int page, @NotNull List<CommandSyntax<S>> commandSubCommands)
@Nullable CommandHelpProvider	helpProvider()
void	log(String msg, Object... args)
<C extends Command<S>> void	registerCommand(C command)
@NotNull SenderProviderRegistry<S>	senderProviderRegistry()
void	setHelpProvider(@Nullable CommandHelpProvider helpProvider)
<N extends Number> void	setNumericArgumentSuggestions(@NotNull ArgumentNumber<N> argNum)
@NotNull List<String>	suggest(Command<S> command, S sender, String[] args)
@NotNull ArgumentTypeRegistry	typeRegistry()
void	unregisterCommand(String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mqzn.commands.base.manager.CommandManager

commandStarter

Field Details

logger

protected final Logger logger

bootstrap

protected final P bootstrap

argumentNumberSuggestionProcessor

@NotNull
protected final @NotNull io.github.mqzn.commands.base.manager.ArgumentNumberSuggestionProcessor argumentNumberSuggestionProcessor

wrapper

@NotNull
protected final @NotNull SenderWrapper<S> wrapper

captionRegistry

@NotNull
protected final @NotNull CaptionRegistry<S> captionRegistry

senderProviderRegistry

@NotNull
protected final @NotNull SenderProviderRegistry<S> senderProviderRegistry

Constructor Details

AbstractCommandManager

public AbstractCommandManager(@NotNull
 P bootstrap,
 @NotNull
 @NotNull SenderWrapper<S> wrapper,
 @NotNull
 CommandExecutionCoordinator.Type coordinator)

AbstractCommandManager

public AbstractCommandManager(@NotNull
 P bootstrap,
 @NotNull
 @NotNull SenderWrapper<S> wrapper)

Method Details

getBootstrap

@NotNull
public P getBootstrap()

Specified by:

getBootstrap in interface CommandManager<P,S>

typeRegistry

@NotNull
public @NotNull ArgumentTypeRegistry typeRegistry()

Specified by:

typeRegistry in interface CommandManager<P,S>

exceptionHandler

@NotNull
public @NotNull CommandExceptionHandler<S> exceptionHandler()

Specified by:

exceptionHandler in interface CommandManager<P,S>

helpProvider

@Nullable
public @Nullable CommandHelpProvider helpProvider()

Specified by:

helpProvider in interface CommandManager<P,S>

setHelpProvider

public void setHelpProvider(@Nullable
 @Nullable CommandHelpProvider helpProvider)

Specified by:

setHelpProvider in interface CommandManager<P,S>

handleHelpProvider

public void handleHelpProvider(@NotNull
 S sender,
 @NotNull
 @NotNull Context<S> context,
 @NotNull
 @NotNull String label,
 int page,
 @NotNull
 @NotNull List<CommandSyntax<S>> commandSubCommands)

Specified by:

handleHelpProvider in interface CommandManager<P,S>

executeCommand

public final <C> void executeCommand(@NotNull
 @NotNull Command<S> command,
 @NotNull
 S sender,
 @NotNull
 @NotNull String[] args)

Specified by:

executeCommand in interface CommandManager<P,S>

findSyntax

@Nullable
public @Nullable CommandSyntax<S> findSyntax(@NotNull
 @NotNull Command<S> command,
 @NotNull
 @NotNull DelegateCommandContext<S> commandContext)

Specified by:

findSyntax in interface CommandManager<P,S>

getSenderWrapper

@NotNull
public @NotNull SenderWrapper<S> getSenderWrapper()

Specified by:

getSenderWrapper in interface CommandManager<P,S>

registerCommand

public <C extends Command<S>> void registerCommand(C command)

Specified by:

registerCommand in interface CommandManager<P,S>

unregisterCommand

public void unregisterCommand(String name)

Specified by:

unregisterCommand in interface CommandManager<P,S>

getCommand

@Nullable
public @Nullable Command<S> getCommand(String name)

Specified by:

getCommand in interface CommandManager<P,S>

getCommands

@NotNull
public @NotNull Collection<Command<S>> getCommands()

Specified by:

getCommands in interface CommandManager<P,S>

flagRegistry

@NotNull
public @NotNull FlagRegistry flagRegistry()

Specified by:

flagRegistry in interface CommandManager<P,S>

captionRegistry

@NotNull
public @NotNull CaptionRegistry<S> captionRegistry()

Specified by:

captionRegistry in interface CommandManager<P,S>

senderProviderRegistry

@NotNull
public @NotNull SenderProviderRegistry<S> senderProviderRegistry()

Specified by:

senderProviderRegistry in interface CommandManager<P,S>

suggest

@NotNull
public @NotNull List<String> suggest(Command<S> command,
 S sender,
 String[] args)

Specified by:

suggest in interface CommandManager<P,S>

findAmbiguity

@NotNull
public @NotNull List<CommandSyntax<S>> findAmbiguity(@NotNull
 @NotNull List<CommandSyntax<S>> syntaxes)

Specified by:

findAmbiguity in interface CommandManager<P,S>

setNumericArgumentSuggestions

public <N extends Number> void setNumericArgumentSuggestions(@NotNull
 @NotNull ArgumentNumber<N> argNum)

Specified by:

setNumericArgumentSuggestions in interface CommandManager<P,S>

log

public void log(String msg,
 Object... args)

Specified by:

log in interface CommandManager<P,S>