Package cloud.commandframework.arguments.standard

Class StringArrayArgument.StringArrayParser<C>

java.lang.Object
cloud.commandframework.arguments.standard.StringArrayArgument.StringArrayParser<C>
Type Parameters:
C - Command sender type
All Implemented Interfaces:
ArgumentParser<C,String[]>
Enclosing class:
StringArrayArgument<C>
@API(status=STABLE) public static final class StringArrayArgument.StringArrayParser<C> extends Object implements ArgumentParser<C,String[]>
Parser that parses input into a string array

  • Constructor Details

    • StringArrayParser

      public StringArrayParser()
      Construct a new string array parser.

    • StringArrayParser

      @API(status=STABLE, since="1.7.0") public StringArrayParser(boolean flagYielding)
      Construct a new string array parser.
      Parameters:
      flagYielding - Whether the parser should stop parsing when encountering a potential flag
      Since:
      1.7.0

  • Method Details

    • parse

      public @NonNull ArgumentParseResult<String @NonNull []> parse(@NonNull CommandContext<@NonNull 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 (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.

      Specified by:
      parse in interface ArgumentParser<C,String[]>
      Parameters:
      commandContext - Command context
      inputQueue - The queue of arguments
      Returns:
      Parsed command result