Completers.FileNameCompleter (JLine Builtins 3.24.0 API)

java.lang.Object

org.jline.builtins.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 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

Constructor Summary

Constructors

Constructor

Description

FileNameCompleter()
Method Summary

Modifier and Type

Method

Description

protected boolean

accept(Path path)

void

complete(org.jline.reader.LineReader reader, org.jline.reader.ParsedLine commandLine, List<org.jline.reader.Candidate> candidates)

protected String

getDisplay(org.jline.terminal.Terminal terminal, Path p, org.jline.utils.StyleResolver resolver, String separator)

protected String

getSeparator(boolean useForwardSlash)

protected Path

getUserDir()

protected Path

getUserHome()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- FileNameCompleter
  
  public FileNameCompleter()
Method Details
- complete
  
  public void complete(org.jline.reader.LineReader reader, org.jline.reader.ParsedLine commandLine, List<org.jline.reader.Candidate> candidates)
  
  Specified by:
  
  complete in interface org.jline.reader.Completer
- accept
  
  protected boolean accept(Path path)
- getUserDir
  
  protected Path getUserDir()
- getUserHome
  
  protected Path getUserHome()
- getSeparator
  
  protected String getSeparator(boolean useForwardSlash)
- getDisplay
  
  protected String getDisplay(org.jline.terminal.Terminal terminal, Path p, org.jline.utils.StyleResolver resolver, String separator)