Alphabetical Index

A B C D E G H I L M O P R S T W

A

addToHistory(String) - static method in class org.gnu.readline.Readline
Add a line to the in-memory history.

B

byName(String) - static method in class org.gnu.readline.ReadlineLibrary
Return ReadlineLibrary-object with given name.

C

cleanup() - static method in class org.gnu.readline.Readline
Reset the readline library and with it, the terminal.
clearHistory() - static method in class org.gnu.readline.Readline
Clear the history buffer.
close() - method in class org.gnu.readline.ReadlineReader
Nullifies all buffers and writes history file if one was given at construction time.
completer(String,int) - method in class org.gnu.readline.ReadlineCompleter
A generator function for filename completion in the general case.
completer(String,int) - method in class test.TestCompleter
Return possible completion.

D

DEFAULT_PROMPT - static field in class org.gnu.readline.ReadlineReader

E

Editline - static field in class org.gnu.readline.ReadlineLibrary
Constant for Editline implementation.

G

getCompleter() - static method in class org.gnu.readline.Readline
Query current completer function.
getEncoding() - static method in class org.gnu.readline.Readline
Query current encoding of fallback BufferedReader.
getHistory(Collection) - static method in class org.gnu.readline.Readline
Get the history buffer in a supplied Collection.
getHistoryLine(int) - static method in class org.gnu.readline.Readline
Get the specified entry from the history buffer.
getHistorySize() - static method in class org.gnu.readline.Readline
Get the size, in elements (lines), of the history buffer.
Getline - static field in class org.gnu.readline.ReadlineLibrary
Constant for Getline implementation.
getLineBuffer() - static method in class org.gnu.readline.Readline
Query the current line buffer.
getName() - method in class org.gnu.readline.ReadlineLibrary
Query name of backing library.
getPrompt() - method in class org.gnu.readline.ReadlineReader
Returns the current prompt.
getThrowExceptionOnUnsupportedMethod() - static method in class org.gnu.readline.Readline
Query behavior in case an unsupported method is called.
getWordBreakCharacters() - static method in class org.gnu.readline.Readline
Query word break characters.
GnuReadline - static field in class org.gnu.readline.ReadlineLibrary
Constant for GNU-Readline implementation.

H

hasTerminal() - static method in class org.gnu.readline.Readline
Return if we have a terminal.

I

initReadline(String) - static method in class org.gnu.readline.Readline
Initialize the GNU-Readline library.

L

load(org.gnu.readline.ReadlineLibrary) - static method in class org.gnu.readline.Readline
Load an implementing backing library.

M

main(String[]) - static method in class org.gnu.readline.ReadlineReader
main(String[]) - static method in class test.ReadlineTest
Main entry point.

O

P

parseAndBind(String) - static method in class org.gnu.readline.Readline
Parse argument string as if it had been read from `inputrc' file and perform key bindings and variable assignments found.
PureJava - static field in class org.gnu.readline.ReadlineLibrary
Constant for fallback, pure Java implementation.

R

read(char[],int,int) - method in class org.gnu.readline.ReadlineReader
Reads what's given from readline() into a buffer.
readHistoryFile(String) - static method in class org.gnu.readline.Readline
Reads a history file into memory

Supporting implementations:

  • GNU-Readline
  • Editline
readInitFile(String) - static method in class org.gnu.readline.Readline
Read keybindings and variable assignments from a file.
Readline - class org.gnu.readline.Readline
This class implements basic functionality of the GNU-readline interface.
readline(String) - static method in class org.gnu.readline.Readline
Display a prompt on standard output and read a string from standard input.
readline(String,boolean) - static method in class org.gnu.readline.Readline
Display a prompt on standard output and read a string from standard input.
ReadlineCompleter - interface org.gnu.readline.ReadlineCompleter
Callback interface that implements completion.
ReadlineLibrary - class org.gnu.readline.ReadlineLibrary
This class implements a typesafe enumeration of the backing libraries.
ReadlineReader - class org.gnu.readline.ReadlineReader
A Reader wrapper for the Readline classes.
Constructs a ReadlineReader object with an associated history file.
ReadlineReader(org.gnu.readline.ReadlineLibrary) - constructor for class org.gnu.readline.ReadlineReader
Constructs a ReadlineReader object with the default prompt.
Constructs a ReadlineReader object with an associated history file and prompt.
Constructs a ReadlineReader object with the given prompt.
ReadlineTest.java This class shows the usage of the readline wrapper.
ReadlineTest() - constructor for class test.ReadlineTest

S

setCompleter(org.gnu.readline.ReadlineCompleter) - static method in class org.gnu.readline.Readline
Set your completer implementation.
setEncoding(String) - static method in class org.gnu.readline.Readline
Set current encoding of fallback BufferedReader.
setPrompt(String) - method in class org.gnu.readline.ReadlineReader
Sets the prompt to the given value.
setThrowExceptionOnUnsupportedMethod(boolean) - static method in class org.gnu.readline.Readline
Configure behavior in case an unsupported method is called.
setWordBreakCharacters(String) - static method in class org.gnu.readline.Readline
Set word break characters.

T

test - package
This class is a sample custom completer.
TestCompleter() - constructor for class test.TestCompleter
Default constructor.

W

writeHistoryFile(String) - static method in class org.gnu.readline.Readline
Writes a history file to disc

Supporting implementations:

  • GNU-Readline
  • Editline

Released under the LGPL, (c) Bernhard Bablok, Henner Zeller 1998-2002
Homepage: http://java-readline.sourceforge.net/