Class StringArgument.StringParser<C>
- All Implemented Interfaces:
ArgumentParser<C,
String>
- Enclosing class:
- StringArgument<C>
-
Field Summary
Fields inherited from interface cloud.commandframework.arguments.parser.ArgumentParser
DEFAULT_ARGUMENT_COUNT
-
Constructor Summary
ConstructorDescriptionStringParser
(@NonNull StringArgument.StringMode stringMode, @NonNull BiFunction<@NonNull CommandContext<C>, @NonNull String, @NonNull List<@NonNull String>> suggestionsProvider) Construct a new string parser -
Method Summary
Modifier and TypeMethodDescription@NonNull StringArgument.StringMode
Get the string modeboolean
Check whether this argument parser is context free.@NonNull ArgumentParseResult<String>
parse
(@NonNull CommandContext<C> commandContext, @NonNull Queue<@NonNull String> inputQueue) Parse command input into a command result.suggestions
(@NonNull CommandContext<C> commandContext, @NonNull String input) Get a list of suggested arguments that would be correctly parsed by this parserMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface cloud.commandframework.arguments.parser.ArgumentParser
getRequestedArgumentCount, map
-
Constructor Details
-
StringParser
public StringParser(@NonNull StringArgument.StringMode stringMode, @NonNull BiFunction<@NonNull CommandContext<C>, @NonNull String, @NonNull List<@NonNull String>> suggestionsProvider) Construct a new string parser- Parameters:
stringMode
- String parsing modesuggestionsProvider
- Suggestions provider
-
-
Method Details
-
parse
public @NonNull ArgumentParseResult<String> parse(@NonNull CommandContext<C> commandContext, @NonNull Queue<@NonNull String> inputQueue) Description copied from interface:ArgumentParser
Parse 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 (usingCommandManager.suggest(Object, String)
). It is possible to useCommandContext.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
CommandContext
.- Specified by:
parse
in interfaceArgumentParser<C,
String> - Parameters:
commandContext
- Command contextinputQueue
- The queue of arguments- Returns:
- Parsed command result
-
suggestions
public @NonNull List<@NonNull String> suggestions(@NonNull CommandContext<C> commandContext, @NonNull String input) Description copied from interface:ArgumentParser
Get a list of suggested arguments that would be correctly parsed by this parserThis method is likely to be called for every character provided by the sender and so it may be necessary to cache results locally to prevent unnecessary computations
- Specified by:
suggestions
in interfaceArgumentParser<C,
String> - Parameters:
commandContext
- Command contextinput
- Input string- Returns:
- List of suggestions
-
isContextFree
public boolean isContextFree()Description copied from interface:ArgumentParser
Check whether this argument parser is context free. A context free parser will not use the provided command context, and so supports impromptu parsing- Specified by:
isContextFree
in interfaceArgumentParser<C,
String> - Returns:
true
if the parser is context free, elsefalse
-
getStringMode
Get the string mode- Returns:
- String mode
-