|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--jline.ConsoleReader
A reader for console applications. It supports custom tab-completion,
saveable command history, and command line editing. On some
platforms, platform-specific commands will need to be
issued before the reader will function properly. See
Terminal.initializeTerminal()
for convenience methods for
issuing platform-specific setup commands.
TODO:
Field Summary | |
static short |
ADD
Operation that |
static short |
ARROW_DOWN
|
static short |
ARROW_LEFT
|
static short |
ARROW_PREFIX
|
static short |
ARROW_RIGHT
|
static short |
ARROW_START
|
static short |
ARROW_UP
|
static char |
BACKSPACE
|
(package private) CursorBuffer |
buf
|
static short |
CHANGE_CASE
Operation that toggles between uppercase and lowercase. |
static short |
CHANGE_META
Operation that |
static short |
CLEAR_SCREEN
Operation that clears the screen. |
static short |
COMPLETE
Operation that performs completion operation on the current word. |
(package private) List |
completors
|
static String |
CR
|
(package private) static PrintWriter |
debugger
|
static short |
DELETE_META
Operation that |
static short |
DELETE_NEXT_CHAR
Operation that deletes the previous character. |
static short |
DELETE_PREV_CHAR
Operation that |
static short |
DELETE_PREV_WORD
Operation that deletes the previous word in the buffer. |
static short |
END_WORD
Operation that |
static short |
EXIT
Operation that exits the command prompt. |
(package private) History |
history
|
(package private) InputStream |
in
|
static short |
INSERT
Operation that |
static char |
KEYBOARD_BELL
|
static SortedMap |
KEYMAP_NAMES
Map that contains the operation name to keymay operation mapping. |
static short |
KILL_LINE
Operation that deletes the buffer from the current character to the end. |
static short |
KILL_LINE_PREV
Operation that deletes the buffer from the cursor to the beginning. |
static short |
MOVE_TO_BEG
Operation that moves to the beginning of the buffer. |
static short |
MOVE_TO_END
Operation that moves to the end of the buffer. |
static short |
NEWLINE
Operation that issues a newline. |
static short |
NEXT_CHAR
Operation that moves to the next character in the buffer. |
static short |
NEXT_HISTORY
Operation that sets the buffer to the next history item. |
static short |
NEXT_SPACE_WORD
Operation that |
static short |
NEXT_WORD
Operation that moved to the next word. |
(package private) Writer |
out
|
static short |
PASTE_NEXT
Operation that |
static short |
PASTE_PREV
Operation that |
static short |
PREV_CHAR
Operation that moved to the previous character in the buffer. |
static short |
PREV_HISTORY
Operation that sets the buffer to the previous history item. |
static short |
PREV_SPACE_WORD
Operation that moved to the previous whitespace. |
static short |
PREV_WORD
Operation that |
(package private) String |
prompt
|
static short |
REDISPLAY
Operation that redisplays the current buffer. |
static short |
REPEAT_NEXT_CHAR
Operation that repeats the character. |
static short |
REPEAT_PREV_CHAR
Operation that moves to the previous character in the buffer. |
static short |
REPEAT_SEARCH_NEXT
Operation that |
static short |
REPEAT_SEARCH_PREV
Operation that |
static short |
REPLACE_CHAR
Operation that |
static short |
REPLACE_MODE
Operation that |
static char |
RESET_LINE
|
static short |
SEARCH_NEXT
Operation that searches forward in the command history. |
static short |
SEARCH_PREV
Operation that searches backwards in the command history. |
static short |
SUBSTITUTE_CHAR
Operation that |
static short |
SUBSTITUTE_LINE
Operation that |
static short |
TO_END_WORD
Operation that moved to the end of the current word. |
static short |
TO_NEXT_CHAR
Operation that |
static short |
TO_PREV_CHAR
Operation that |
static short |
UNDO
Operation that undoes the previous operation. |
static short |
UNKNOWN
Unknown operation. |
Constructor Summary | |
ConsoleReader()
Create a new reader using FileDescriptor.in for input
and System.out for output. |
|
ConsoleReader(InputStream in,
Writer out)
Create a new reader using the specified InputStream
for input and the specific writer for output, using the
default keybindings resource. |
|
ConsoleReader(InputStream in,
Writer out,
InputStream bindings)
Create a new reader. |
Method Summary | |
boolean |
addCompletor(Completor completor)
Add the specified Completor to the list of handlers
for tab-completion. |
boolean |
backspace()
Issue a backspace. |
void |
beep()
Issue an audible keyboard bell, if getBellEnabled() return true. |
(package private) int |
clearEcho(int c)
Clear the echoed characters for the specified character code. |
(package private) int |
countEchoCharacters(char c)
|
static void |
debug(String str)
debug. |
void |
drawLine()
Output put the prompt + the current buffer |
(package private) String |
finishBuffer()
Clear the buffer and add its contents to the history. |
void |
flushConsole()
Flush the console output stream. |
int |
getAutoprintThreshhold()
|
boolean |
getBellEnabled()
|
CompletionHandler |
getCompletionHandler()
|
Collection |
getCompletors()
Returns an unmodifiable list of all the completors. |
CursorBuffer |
getCursorBuffer()
|
(package private) int |
getCursorPosition()
|
boolean |
getEcho()
|
Character |
getEchoCharacter()
Returns the echo character. |
History |
getHistory()
|
InputStream |
getInput()
Returns the stream used for console input. |
(package private) int |
getKeyForAction(short logicalAction)
|
(package private) StringBuffer |
getPrintableCharacters(char ch)
Return the number of characters that will be printed when the specified character is echoed to the screen. |
int |
getTermheight()
Query the terminal to find the current width; |
int |
getTermwidth()
Query the terminal to find the current width; |
boolean |
killLine()
Kill the buffer ahead of the current cursor position. |
void |
printColumns(Collection stuff)
Output the specified Collection in proper columns. |
void |
printNewline()
Output a platform-dependant newline. |
void |
printString(String str)
Output the specified string to the output stream (but not the buffer). |
void |
putString(String str)
Write out the specified string to the buffer and the output stream. |
int |
readCharacter()
Read a character from the console. |
String |
readLine()
Read the next line and return the contents of the buffer. |
String |
readLine(String prompt)
Read a line from the in InputStream , and
return the line (without any trailing newlines). |
void |
redrawLine()
Clear the line and redraw it. |
boolean |
removeCompletor(Completor completor)
Remove the specified Completor from the list of handlers
for tab-completion. |
(package private) boolean |
resetLine()
Erase the current line. |
void |
setAutoprintThreshhold(int autoprintThreshhold)
|
void |
setBellEnabled(boolean bellEnabled)
|
void |
setCompletionHandler(CompletionHandler completionHandler)
|
boolean |
setCursorPosition(int position)
Move the cursor position to the specified absolute index. |
void |
setDebug(PrintWriter debugger)
Set the stream for debugging. |
void |
setEcho(boolean echo)
|
void |
setEchoCharacter(Character echoCharacter)
Set the echo character. |
void |
setHistory(History history)
|
void |
setInput(InputStream in)
Set the stream to be used for console input. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
String prompt
public static final String CR
public static final char BACKSPACE
public static final char RESET_LINE
public static final char KEYBOARD_BELL
public static final short ARROW_START
public static final short ARROW_PREFIX
public static final short ARROW_LEFT
public static final short ARROW_RIGHT
public static final short ARROW_UP
public static final short ARROW_DOWN
public static final short UNKNOWN
public static final short MOVE_TO_BEG
public static final short MOVE_TO_END
public static final short PREV_CHAR
public static final short NEWLINE
public static final short KILL_LINE
public static final short CLEAR_SCREEN
public static final short NEXT_HISTORY
public static final short PREV_HISTORY
public static final short REDISPLAY
public static final short KILL_LINE_PREV
public static final short DELETE_PREV_WORD
public static final short NEXT_CHAR
public static final short REPEAT_PREV_CHAR
public static final short SEARCH_PREV
public static final short REPEAT_NEXT_CHAR
public static final short SEARCH_NEXT
public static final short PREV_SPACE_WORD
public static final short TO_END_WORD
public static final short REPEAT_SEARCH_PREV
public static final short PASTE_PREV
public static final short REPLACE_MODE
public static final short SUBSTITUTE_LINE
public static final short TO_PREV_CHAR
public static final short NEXT_SPACE_WORD
public static final short DELETE_PREV_CHAR
public static final short ADD
public static final short PREV_WORD
public static final short CHANGE_META
public static final short DELETE_META
public static final short END_WORD
public static final short INSERT
public static final short REPEAT_SEARCH_NEXT
public static final short PASTE_NEXT
public static final short REPLACE_CHAR
public static final short SUBSTITUTE_CHAR
public static final short TO_NEXT_CHAR
public static final short UNDO
public static final short NEXT_WORD
public static final short DELETE_NEXT_CHAR
public static final short CHANGE_CASE
public static final short COMPLETE
public static final short EXIT
public static SortedMap KEYMAP_NAMES
InputStream in
final Writer out
final CursorBuffer buf
static PrintWriter debugger
History history
final List completors
Constructor Detail |
public ConsoleReader() throws IOException
FileDescriptor.in
for input
and System.out
for output. FileDescriptor.in
is
used because it has a better chance of being unbuffered.
public ConsoleReader(InputStream in, Writer out) throws IOException
InputStream
for input and the specific writer for output, using the
default keybindings resource.
public ConsoleReader(InputStream in, Writer out, InputStream bindings) throws IOException
in
- the inputout
- the outputbindings
- the key bindings to useMethod Detail |
public void setDebug(PrintWriter debugger)
public void setInput(InputStream in)
public InputStream getInput()
public String readLine() throws IOException
IOException
public void setBellEnabled(boolean bellEnabled)
bellEnabled
- if true, enable audible keyboard bells if
an alert is required.public boolean getBellEnabled()
public int getTermwidth()
Terminal.getTerminalWidth()
public int getTermheight()
Terminal#getTerminalheight
public void setAutoprintThreshhold(int autoprintThreshhold)
autoprintThreshhold
- the number of candidates to print
without issuing a warning.public int getAutoprintThreshhold()
int getKeyForAction(short logicalAction)
int clearEcho(int c) throws IOException
IOException
int countEchoCharacters(char c)
StringBuffer getPrintableCharacters(char ch)
int getCursorPosition()
public String readLine(String prompt) throws IOException
InputStream
, and
return the line (without any trailing newlines).
prompt
- the prompt to issue to the console, may be null.
IOException
public boolean killLine() throws IOException
IOException
public CursorBuffer getCursorBuffer()
public void printColumns(Collection stuff) throws IOException
Collection
in proper columns.
stuff
- the stuff to print
IOException
public boolean addCompletor(Completor completor)
Completor
to the list of handlers
for tab-completion.
completor
- the Completor
to add
public boolean removeCompletor(Completor completor)
Completor
from the list of handlers
for tab-completion.
completor
- the Completor
to remove
public Collection getCompletors()
final boolean resetLine() throws IOException
IOException
public final boolean setCursorPosition(int position) throws IOException
IOException
public final void redrawLine() throws IOException
IOException
public final void drawLine() throws IOException
IOException
public final void printNewline() throws IOException
IOException
final String finishBuffer()
public final void putString(String str) throws IOException
IOException
public final void printString(String str) throws IOException
IOException
public final void beep() throws IOException
getBellEnabled()
return true.
IOException
public final void flushConsole() throws IOException
IOException
public final boolean backspace() throws IOException
IOException
public static void debug(String str)
str
- the message to issue.public final int readCharacter() throws IOException
IOException
public void setHistory(History history)
public History getHistory()
public void setEcho(boolean echo)
public boolean getEcho()
public void setCompletionHandler(CompletionHandler completionHandler)
public CompletionHandler getCompletionHandler()
public void setEchoCharacter(Character echoCharacter)
Set the echo character. For example, to have "*" entered when a password is typed:
myConsoleReader.setEchoCharacter (new Character ('*'));
Setting the character to
nullwill restore normal character echoing. Setting the character to
new Character (0)will cause nothing to be echoed.
echoCharacter
- the character to echo to the console in
place of the typed character.public Character getEchoCharacter()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |