Class Completers.FileNameCompleter

  • All Implemented Interfaces:
    org.jline.reader.Completer
    Direct Known Subclasses:
    Completers.DirectoriesCompleter, Completers.FilesCompleter
    Enclosing class:
    Completers

    public static class Completers.FileNameCompleter
    extends java.lang.Object
    implements org.jline.reader.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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean accept​(java.nio.file.Path path)  
      void complete​(org.jline.reader.LineReader reader, org.jline.reader.ParsedLine commandLine, java.util.List<org.jline.reader.Candidate> candidates)  
      protected java.lang.String getDisplay​(org.jline.terminal.Terminal terminal, java.nio.file.Path p, org.jline.utils.StyleResolver resolver, java.lang.String separator)  
      protected java.lang.String getSeparator​(boolean useForwardSlash)  
      protected java.nio.file.Path getUserDir()  
      protected java.nio.file.Path getUserHome()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • FileNameCompleter

        public FileNameCompleter()
    • Method Detail

      • complete

        public void complete​(org.jline.reader.LineReader reader,
                             org.jline.reader.ParsedLine commandLine,
                             java.util.List<org.jline.reader.Candidate> candidates)
        Specified by:
        complete in interface org.jline.reader.Completer
      • accept

        protected boolean accept​(java.nio.file.Path path)
      • getUserDir

        protected java.nio.file.Path getUserDir()
      • getUserHome

        protected java.nio.file.Path getUserHome()
      • getSeparator

        protected java.lang.String getSeparator​(boolean useForwardSlash)
      • getDisplay

        protected java.lang.String getDisplay​(org.jline.terminal.Terminal terminal,
                                              java.nio.file.Path p,
                                              org.jline.utils.StyleResolver resolver,
                                              java.lang.String separator)