Interface ConsoleCommandCompleter

All Known Implementing Classes:
StringsCompleter

@NonNullByDefault public interface ConsoleCommandCompleter
Implementing this interface allows a ConsoleCommandExtension to provide completions for the user as they write commands.
Author:
Cody Cutrer - Initial contribution
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    complete(String[] args, int cursorArgumentIndex, int cursorPosition, List<String> candidates)
    Populate possible completion candidates.
  • Method Details

    • complete

      boolean complete(String[] args, int cursorArgumentIndex, int cursorPosition, List<String> candidates)
      Populate possible completion candidates.
      Parameters:
      args - An array of all arguments to be passed to the ConsoleCommandExtension's execute method
      cursorArgumentIndex - the argument index the cursor is currently in
      cursorPosition - the position of the cursor within the argument
      candidates - a list to fill with possible completion candidates
      Returns:
      if a candidate was found