Package cloud.commandframework.arguments.parser

Interface ArgumentParser<C,​T>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_ARGUMENT_COUNT
      Default amount of arguments that the parser expects to consume

    • Field Detail

      • DEFAULT_ARGUMENT_COUNT

        static final int DEFAULT_ARGUMENT_COUNT
        Default amount of arguments that the parser expects to consume
        See Also:
        Constant Field Values

    • Method Detail

      • parse

        @NonNull ArgumentParseResult<@NonNull T> parse​(@NonNull CommandContext<@NonNull C> commandContext,
                                               @NonNull java.util.Queue<@NonNull java.lang.String> inputQueue)
        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 (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 CommandContext.

        Parameters:
        commandContext - Command context
        inputQueue - The queue of arguments
        Returns:
        Parsed command result

      • suggestions

        default @NonNull java.util.List<@NonNull java.lang.String> suggestions​(@NonNull CommandContext<C> commandContext,
                                                                       @NonNull java.lang.String input)
        Get a list of suggested arguments that would be correctly parsed by this parser

        This 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

        Parameters:
        commandContext - Command context
        input - Input string
        Returns:
        List of suggestions

      • isContextFree

        default boolean isContextFree()
        Check 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
        Returns:
        true if the parser is context free, else false

      • getRequestedArgumentCount

        default int getRequestedArgumentCount()
        Get the amount of arguments that this parsers seeks to consume
        Returns:
        The number of arguments tha the parser expects
        Since:
        1.1.0