Class Completers.FileNameCompleter

java.lang.Object
org.jline.builtins.Completers.FileNameCompleter
All Implemented Interfaces:
Completer
Direct Known Subclasses:
Completers.DirectoriesCompleter, Completers.FilesCompleter
Enclosing class:
Completers
public static class Completers.FileNameCompleter extends Object implements Completer
A file name completer takes the buffer and issues a list of potential completions.

This completer tries to behave as similar as possible to bash's file name completion (using GNU readline) with the following exceptions:

  • Candidates that are directories will end with "/"
  • Wildcard regular expressions are not evaluated or replaced
  • The "~" character can be used to represent the user's home, but it cannot complete to other users' homes, since java does not provide any way of determining that easily
Since:
2.3
Author:
Marc Prud'hommeaux, Jason Dillon

  • Constructor Details

    • FileNameCompleter

      public FileNameCompleter()

  • Method Details

    • complete

      public void complete(LineReader reader, ParsedLine commandLine, List<Candidate> candidates)
      Description copied from interface: Completer
      Populates candidates with a list of possible completions for the command line.

      The list of candidates will be sorted and filtered by the LineReader, so that the list of candidates displayed to the user will usually be smaller than the list given by the completer. Thus it is not necessary for the completer to do any matching based on the current buffer. On the contrary, in order for the typo matcher to work, all possible candidates for the word being completed should be returned.

      Implementations should add Candidate objects to the candidates list. Each candidate can include additional information such as descriptions, groups, and display attributes that will be used when presenting completion options to the user.

      This method is called by the LineReader when the user requests completion, typically by pressing the Tab key.

      Specified by:
      complete in interface Completer
      Parameters:
      reader - The line reader instance that is requesting completion
      commandLine - The parsed command line containing the current input state
      candidates - The List of candidates to populate with completion options
      See Also:

    • accept

      protected boolean accept(Path path)

    • getUserDir

      protected Path getUserDir()

    • getUserHome

      protected Path getUserHome()

    • getSeparator

      protected String getSeparator(boolean useForwardSlash)

    • getDisplay

      protected String getDisplay(Terminal terminal, Path p, StyleResolver resolver, String separator)