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

BatsTestReader - Class in test

BatsTestReader.java Prompts for input, then echos back what is reads.

BatsTestReader() - Constructor for class test.BatsTestReader

BatsTestVar - Class in test

BatsTestVar.java Sets a var and then gets the value, printing to stdout.

BatsTestVar() - Constructor for class test.BatsTestVar

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 interface 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 variable in class org.gnu.readline.ReadlineReader

E

Editline - Static variable 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 variable 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.

getVar(ReadlineConstInt) - Static method in class org.gnu.readline.Readline

Query integer readline-variable.

getVar(ReadlineConstString) - Static method in class org.gnu.readline.Readline

Query string readline-variable.

getWordBreakCharacters() - Static method in class org.gnu.readline.Readline

Query word break characters.

GnuReadline - Static variable 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.

HISTORY_BASE - Static variable in class org.gnu.readline.Readline

Constant to access history_base using getVar() or setVar().

HISTORY_LENGTH - Static variable in class org.gnu.readline.Readline

Constant to access history_length using getVar() or setVar().

HISTORY_MAX_ENTRIES - Static variable in class org.gnu.readline.Readline

Constant to access history_max_entries using getVar() or setVar().

HISTORY_NO_EXPAND_CHARS - Static variable in class org.gnu.readline.Readline

Constant to access history_no_expand_chars using getVar() or setVar().

HISTORY_QUOTES_EXPANSION - Static variable in class org.gnu.readline.Readline

Constant to access history_quotes_inhibit_expansion using getVar() or setVar().

HISTORY_SEARCH_DELIMITERS - Static variable in class org.gnu.readline.Readline

Constant to access history_search_delimiter_chars using getVar() or setVar().

HISTORY_WORD_DELIMITERS - Static variable in class org.gnu.readline.Readline

Constant to access history_word_delimiters using getVar() or setVar().

I

initReadline(String) - Static method in class org.gnu.readline.Readline

Initialize the GNU-Readline library.

L

load(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.BatsTestReader

Main entry point.

main(String[]) - Static method in class test.BatsTestVar

Main entry point.

main(String[]) - Static method in class test.ReadlineTest

Main entry point.

O

org.gnu.readline - package org.gnu.readline

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 variable 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

readInitFile(String) - Static method in class org.gnu.readline.Readline

Read keybindings and variable assignments from a file.

Readline - Class in org.gnu.readline

This class implements basic functionality of the GNU-readline interface.

Readline() - Constructor for class org.gnu.readline.Readline

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 in org.gnu.readline

Callback interface that implements completion.

ReadlineLibrary - Class in org.gnu.readline

This class implements a typesafe enumeration of the backing libraries.

ReadlineReader - Class in org.gnu.readline

A Reader wrapper for the Readline classes.

ReadlineReader(String, ReadlineLibrary) - Constructor for class org.gnu.readline.ReadlineReader

Constructs a ReadlineReader object with the given prompt.

ReadlineReader(ReadlineLibrary) - Constructor for class org.gnu.readline.ReadlineReader

Constructs a ReadlineReader object with the default prompt.

ReadlineReader(File, ReadlineLibrary) - Constructor for class org.gnu.readline.ReadlineReader

Constructs a ReadlineReader object with an associated history file.

ReadlineReader(String, File, ReadlineLibrary) - Constructor for class org.gnu.readline.ReadlineReader

Constructs a ReadlineReader object with an associated history file and prompt.

ReadlineTest - Class in test

ReadlineTest.java This class shows the usage of the readline wrapper.

ReadlineTest() - Constructor for class test.ReadlineTest

RL_ALREADY_PROMPTED - Static variable in class org.gnu.readline.Readline

Constant to access rl_already_prompted using getVar() or setVar().

RL_ATTEMPTED_COMPLETION_OVER - Static variable in class org.gnu.readline.Readline

Constant to access rl_attempted_completion_over using getVar() or setVar().

RL_BASIC_QUOTE_CHARACTERS - Static variable in class org.gnu.readline.Readline

Constant to access rl_basic_quote_characters using getVar() or setVar().

RL_BASIC_WORD_BREAK_CHARACTERS - Static variable in class org.gnu.readline.Readline

Constant to access rl_basic_word_break_characters using getVar() or setVar().

RL_CATCH_SIGNALS - Static variable in class org.gnu.readline.Readline

Constant to access rl_catch_signals using getVar() or setVar().

RL_CATCH_SIGWINCH - Static variable in class org.gnu.readline.Readline

Constant to access rl_catch_sigwinch using getVar() or setVar().

RL_COMPLETER_QUOTE_CHARACTERS - Static variable in class org.gnu.readline.Readline

Constant to access rl_completer_quote_characters using getVar() or setVar().

RL_COMPLETER_WORD_BREAK_CHARACTERS - Static variable in class org.gnu.readline.Readline

Constant to access rl_completer_word_break_characters using getVar() or setVar().

RL_COMPLETION_APPEND_CHARACTER - Static variable in class org.gnu.readline.Readline

Constant to access rl_completion_append_character using getVar() or setVar().

RL_COMPLETION_MARK_SYMLINK_DIRS - Static variable in class org.gnu.readline.Readline

Constant to access rl_completion_mark_symlink_dirs using getVar() or setVar().

RL_COMPLETION_QUERY_ITEMS - Static variable in class org.gnu.readline.Readline

Constant to access rl_completion_query_items using getVar() or setVar().

RL_COMPLETION_SUPPRESS_APPEND - Static variable in class org.gnu.readline.Readline

Constant to access rl_completion_suppress_append using getVar() or setVar().

RL_COMPLETION_TYPE - Static variable in class org.gnu.readline.Readline

Constant to access rl_completion_type using getVar() or setVar().

RL_DISPATCHING - Static variable in class org.gnu.readline.Readline

Constant to access rl_dispatching using getVar() or setVar().

RL_DONE - Static variable in class org.gnu.readline.Readline

Constant to access rl_done using getVar() or setVar().

RL_EDITING_MODE - Static variable in class org.gnu.readline.Readline

Constant to access rl_editing_mode using getVar() or setVar().

RL_END - Static variable in class org.gnu.readline.Readline

Constant to access rl_end using getVar() or setVar().

RL_ERASE_EMPTY_LINE - Static variable in class org.gnu.readline.Readline

Constant to access rl_erase_empty_line using getVar() or setVar().

RL_EXECUTING_MACRO - Static variable in class org.gnu.readline.Readline

Constant to access rl_executing_macro using getVar() or setVar().

RL_EXPLICIT_ARG - Static variable in class org.gnu.readline.Readline

Constant to access rl_explicit_arg using getVar() or setVar().

RL_FILENAME_COMPLETION_DESIRED - Static variable in class org.gnu.readline.Readline

Constant to access rl_filename_completion_desired using getVar() or setVar().

RL_FILENAME_QUOTE_CHARACTERS - Static variable in class org.gnu.readline.Readline

Constant to access rl_filename_quote_characters using getVar() or setVar().

RL_FILENAME_QUOTING_DESIRED - Static variable in class org.gnu.readline.Readline

Constant to access rl_filename_quoting_desired using getVar() or setVar().

RL_GNU_READLINE_P - Static variable in class org.gnu.readline.Readline

Constant to access rl_gnu_readline_p using getVar() or setVar().

RL_IGNORE_COMPLETION_DUPLICATES - Static variable in class org.gnu.readline.Readline

Constant to access rl_ignore_completion_duplicates using getVar() or setVar().

RL_INHIBIT_COMPLETION - Static variable in class org.gnu.readline.Readline

Constant to access rl_inhibit_completion using getVar() or setVar().

RL_INSERT_MODE - Static variable in class org.gnu.readline.Readline

Constant to access rl_insert_mode using getVar() or setVar().

RL_LIBRARY_VERSION - Static variable in class org.gnu.readline.Readline

Constant to access rl_library_version using getVar() or setVar().

RL_LINE_BUFFER - Static variable in class org.gnu.readline.Readline

Constant to access rl_line_buffer using getVar() or setVar().

RL_MARK - Static variable in class org.gnu.readline.Readline

Constant to access rl_mark using getVar() or setVar().

RL_NUM_CHARS_TO_READ - Static variable in class org.gnu.readline.Readline

Constant to access rl_num_chars_to_read using getVar() or setVar().

RL_NUMERIC_ARG - Static variable in class org.gnu.readline.Readline

Constant to access rl_numeric_arg using getVar() or setVar().

RL_PENDING_INPUT - Static variable in class org.gnu.readline.Readline

Constant to access rl_pending_input using getVar() or setVar().

RL_POINT - Static variable in class org.gnu.readline.Readline

Constant to access rl_point using getVar() or setVar().

RL_PROMPT - Static variable in class org.gnu.readline.Readline

Constant to access rl_prompt using getVar() or setVar().

RL_READLINE_NAME - Static variable in class org.gnu.readline.Readline

Constant to access rl_readline_name using getVar() or setVar().

RL_READLINE_STATE - Static variable in class org.gnu.readline.Readline

Constant to access rl_readline_state using getVar() or setVar().

RL_READLINE_VERSION - Static variable in class org.gnu.readline.Readline

Constant to access rl_readline_version using getVar() or setVar().

RL_SPECIAL_PREFIXES - Static variable in class org.gnu.readline.Readline

Constant to access rl_special_prefixes using getVar() or setVar().

RL_TERMINAL_NAME - Static variable in class org.gnu.readline.Readline

Constant to access rl_terminal_name using getVar() or setVar().

S

setCompleter(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.

setVar(ReadlineConstInt, int) - Static method in class org.gnu.readline.Readline

Set integer readline-variable.

setVar(ReadlineConstString, String) - Static method in class org.gnu.readline.Readline

Set string readline-variable.

setWordBreakCharacters(String) - Static method in class org.gnu.readline.Readline

Set word break characters.

T

test - package test

TestCompleter - Class in test

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

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