jline

Class FileNameCompletor

Implemented Interfaces:
Completor

public class FileNameCompletor
extends java.lang.Object
implements Completor

A file name completor takes the buffer and issues a list of potential completions.

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

TODO

Author:
Marc Prud'hommeaux

Method Summary

int
complete(String buf, int cursor, List candidates)
int
matchFiles(String buffer, String translated, File[] entries, List candidates)
Match the specified buffer to the array of entries and enter the matches into the list of candidates.
protected void
sortFileNames(List fileNames)

Method Details

complete

public int complete(String buf,
                    int cursor,
                    List candidates)
Specified by:
complete in interface Completor

matchFiles

public int matchFiles(String buffer,
                      String translated,
                      File[] entries,
                      List candidates)
Match the specified buffer to the array of entries and enter the matches into the list of candidates. This method can be overridden in a subclass that wants to do more sophisticated file name completion.
Parameters:
buffer - the untranslated buffer
translated - the buffer with common characters replaced
entries - the list of files to match
candidates - the list of candidates to populate
Returns:
the offset of the match

sortFileNames

protected void sortFileNames(List fileNames)