Package org.jline.builtins
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 java.lang.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
-
-
Constructor Summary
Constructors Constructor Description FileNameCompleter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
accept(java.nio.file.Path path)
void
complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)
Populates candidates with a list of possible completions for the command line.protected java.lang.String
getDisplay(Terminal terminal, java.nio.file.Path p, 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()
-
-
-
Method Detail
-
complete
public void complete(LineReader reader, ParsedLine commandLine, java.util.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.
-
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(Terminal terminal, java.nio.file.Path p, StyleResolver resolver, java.lang.String separator)
-
-