ConsoleReader

The equivalent of hitting <RET>. The line is considered complete and is returned.

Add the specified Completer to the list of handlers for tab-completion.

Adding a triggered Action allows to give another curse of action if a character passed the pre-processing.

Say you want to close the application if the user enter q. addTriggerAction('q', new ActionListener(){ System.exit(0); }); would do the trick.

Issue a backspace.

Issue an audible keyboard bell.

Clear the screen by issuing the ANSI "clear screen" code.

Issue a delete.

Output put the prompt + the current buffer

Flush the console output stream. This is important for printout out single characters (like a backspace or keyboard) that we want the console to handle immediately.

Get whether the console bell is enabled

Returns an unmodifiable list of all the completers.

Returns the echo character.

Get whether user interrupt handling is enabled

Returns the name of the current key mapping.

Whether or not to add new commands to the history buffer.

Whether to use pagination when the number of rows of candidates exceeds the height of the terminal.

Kill the buffer ahead of the current cursor position.

Move the cursor where characters.

Paste the contents of the clipboard into the console buffer

Output the specified string to the output stream (but not the buffer).

Output the specified Collection in proper columns.

Output a platform-dependant newline.

Write out the specified string to the buffer and the output stream.

Read a character from the console.

Read a line from the in InputStream, and return the line (without any trailing newlines).

Read the next line with the specified character mask. If null, then characters will be echoed. If 0, then no characters will be echoed.

Read the next line and return the contents of the buffer.

Clear the line and redraw it.

Remove the specified Completer from the list of handlers for tab-completion.

Erases the current line with the existing prompt, then redraws the line with the provided prompt and buffer

Search backward in history from a given position.

Search backwards in history from the current position.

Search forwards in history from the current position.

Search forward in history from a given position.

Set whether the console bell is enabled.

Sets the string that will be used to start a comment when the insert-comment key is struck.

Enables or disables copy and paste detection. The effect of enabling this this setting is that when a tab is received immediately followed by another character, the tab will not be treated as a completion, but as a tab literal.

Move the cursor position to the specified absolute index.

Set the echo character. For example, to have "*" entered when a password is typed:

 myConsoleReader.setEchoCharacter(new Character('*'));
 

Setting the character to

 null
 

will restore normal character echoing. Setting the character to

 new Character(0)
 

will cause nothing to be echoed.

Set whether user interrupts (ctrl-C) are handled by having JLine throw UserInterruptException from readLine(). Otherwise, the JVM will handle SIGINT as normal, which usually causes it to exit. The default is false.

Whether or not to add new commands to the history buffer.

Sets the current keymap by name. Supported keymaps are "emacs", "vi-insert", "vi-move".

Whether to use pagination when the number of rows of candidates exceeds the height of the terminal.

Shuts the console reader down. This method should be called when you have completed using the reader as it shuts down and cleans up resources that would otherwise be "leaked".

Move the visual cursor backwards without modifying the buffer cursor.

Use the completers to modify the buffer with the appropriate completions.

Expand event designator such as !!, !#, !3, etc... See http://www.gnu.org/software/bash/manual/html_node/Event-Designators.html

Shuts down the ConsoleReader if the JVM attempts to clean it up.

Erase the current line.