Package jline

Class CandidateListCompletionHandler

java.lang.Object
jline.CandidateListCompletionHandler
All Implemented Interfaces:
CompletionHandler

public class CandidateListCompletionHandler extends Object implements CompletionHandler

A CompletionHandler that deals with multiple distinct completions by outputting the complete list of possibilities to the console. This mimics the behavior of the readline library.

TODO:
  • handle quotes and escaped quotes
  • enable automatic escaping of whitespace
Author:
Marc Prud'hommeaux
  • Constructor Details

    • CandidateListCompletionHandler

      public CandidateListCompletionHandler()
  • Method Details

    • setAlwaysIncludeNewline

      public void setAlwaysIncludeNewline(boolean eagerNewlines)
    • complete

      public boolean complete(ConsoleReader reader, List candidates, int pos) throws IOException
      Specified by:
      complete in interface CompletionHandler
      Throws:
      IOException
    • setBuffer

      public static void setBuffer(ConsoleReader reader, String value, int offset) throws IOException
      Throws:
      IOException
    • printCandidates

      public static final void printCandidates(ConsoleReader reader, Collection candidates, boolean eagerNewlines) throws IOException
      Print out the candidates. If the size of the candidates is greated than the
      invalid reference
      getAutoprintThreshhold
      , they prompt with aq warning.
      Parameters:
      candidates - the list of candidates to print
      Throws:
      IOException