All Methods Instance Methods Concrete Methods Modifier and Type Method Description
isContextFree()Check whether or not this argument parser is context free.
parse(@NonNull CommandContext<C> commandContext, @NonNull Queue<@NonNull String> inputQueue)Parse command input into a command result.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public @NonNull ArgumentParseResult<User> parse(@NonNull CommandContext<C> commandContext, @NonNull Queue<@NonNull String> inputQueue)Description copied from interface:
ArgumentParserParse command input into a command result.
This method may be called when a command chain is being parsed for execution (using
CommandManager.executeCommand(Object, String)) or when a command is being parsed to provide context for suggestions (using
CommandManager.suggest(Object, String)). It is possible to use
CommandContext.isSuggestions()} to see what the purpose of the parsing is. Particular care should be taken when parsing for suggestions, as the parsing method is then likely to be called once for every character written by the command sender.
This method should never throw any exceptions under normal circumstances. Instead, if the parsing for some reason cannot be done successfully
ArgumentParseResult.failure(Throwable)should be returned. This then wraps any exception that should be forwarded to the command sender.
The parser is assumed to be completely stateless and should not store any information about the command sender or the command context. Instead, information should be stored in the
public boolean isContextFree()Description copied from interface:
ArgumentParserCheck whether or not this argument parser is context free. A context free parser will not use the provided command context, and so supports impromptu parsing