Package cloud.commandframework.arguments.parser

Class MappedArgumentParser<C,I,O>

java.lang.Object
cloud.commandframework.arguments.parser.MappedArgumentParser<C,I,O>
Type Parameters:
C - sender type
I - base output type
O - mapped output type
All Implemented Interfaces:
ArgumentParser<C,O>
@API(status=STABLE, since="1.5.0") public final class MappedArgumentParser<C,I,O> extends Object implements ArgumentParser<C,O>
An argument parser which wraps another argument parser, converting the output type.
Since:
1.5.0

  • Method Details

    • getBaseParser

      public ArgumentParser<C,I> getBaseParser()
      Get the parser this one is derived from.
      Returns:
      the base parser

    • parse

      public @NonNull ArgumentParseResult<@NonNull O> 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,I>
      Parameters:
      commandContext - Command context
      inputQueue - 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 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

      Specified by:
      suggestions in interface ArgumentParser<C,I>
      Parameters:
      commandContext - Command context
      input - Input string
      Returns:
      List of suggestions

    • map

      public <O1> @NonNull ArgumentParser<C,O1> map(BiFunction<CommandContext<C>,O,ArgumentParseResult<O1>> mapper)
      Description copied from interface: ArgumentParser
      Create a derived argument parser preserving all properties of this parser, but converting the output type.
      Specified by:
      map in interface ArgumentParser<C,I>
      Type Parameters:
      O1 - the result type
      Parameters:
      mapper - the mapper to apply
      Returns:
      a derived parser.

    • 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 interface ArgumentParser<C,I>
      Returns:
      true if the parser is context free, else false

    • getRequestedArgumentCount

      public int getRequestedArgumentCount()
      Description copied from interface: ArgumentParser
      Get the amount of arguments that this parsers seeks to consume
      Specified by:
      getRequestedArgumentCount in interface ArgumentParser<C,I>
      Returns:
      The number of arguments tha the parser expects

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object other)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object