|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjline.console.ConsoleReader
public class 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.init()
for convenience
methods for issuing platform-specific setup commands.
Field Summary | |
---|---|
static char |
BACKSPACE
|
static java.lang.String |
CR
|
static java.lang.String |
JLINE_COMPLETION_THRESHOLD
|
static java.lang.String |
JLINE_KEYBINDINGS
|
static java.lang.String |
JLINE_NOBELL
|
static java.lang.String |
JLINEBINDINGS_PROPERTIES
|
static char |
KEYBOARD_BELL
|
static char |
NULL_MASK
|
static char |
RESET_LINE
|
static int |
TAB_WIDTH
|
Constructor Summary | |
---|---|
ConsoleReader()
Create a new reader using FileDescriptor.in for input and
System.out for output. |
|
ConsoleReader(java.io.InputStream in,
java.io.Writer out)
|
|
ConsoleReader(java.io.InputStream in,
java.io.Writer out,
java.io.InputStream bindings,
Terminal term)
|
|
ConsoleReader(java.io.InputStream in,
java.io.Writer out,
Terminal term)
|
Method Summary | |
---|---|
boolean |
addCompleter(Completer completer)
Add the specified Completer to the list of handlers for tab-completion. |
void |
addTriggeredAction(char c,
java.awt.event.ActionListener listener)
Adding a triggered Action allows to give another curse of action if a character passed the pre-processing. |
boolean |
backspace()
Issue a backspace. |
void |
beep()
Issue an audible keyboard bell, if isBellEnabled() return true. |
boolean |
clearScreen()
Clear the screen by issuing the ANSI "clear screen" code. |
boolean |
delete()
Issue a delete. |
void |
drawLine()
Output put the prompt + the current buffer |
void |
flush()
Flush the console output stream. |
int |
getAutoprintThreshold()
|
java.util.Collection<Completer> |
getCompleters()
Returns an unmodifiable list of all the completers. |
CompletionHandler |
getCompletionHandler()
|
CursorBuffer |
getCursorBuffer()
|
java.lang.Character |
getEchoCharacter()
Returns the echo character. |
History |
getHistory()
|
java.io.InputStream |
getInput()
|
java.io.Writer |
getOutput()
|
java.lang.String |
getPrompt()
|
Terminal |
getTerminal()
|
boolean |
isBellEnabled()
|
boolean |
isHistoryEnabled()
Whether or not to add new commands to the history buffer. |
boolean |
isPaginationEnabled()
Whether to use pagination when the number of rows of candidates exceeds the height of the terminal. |
boolean |
killLine()
Kill the buffer ahead of the current cursor position. |
int |
moveCursor(int num)
Move the cursor where characters. |
boolean |
paste()
Paste the contents of the clipboard into the console buffer |
void |
print(java.lang.CharSequence s)
Output the specified string to the output stream (but not the buffer). |
void |
printColumns(java.util.Collection<? extends java.lang.CharSequence> items)
Output the specified Collection in proper columns. |
void |
println()
Output a platform-dependant newline. |
void |
println(java.lang.CharSequence s)
|
void |
printSearchStatus(java.lang.String searchTerm,
java.lang.String match)
|
void |
putString(java.lang.CharSequence str)
Write out the specified string to the buffer and the output stream. |
int |
readCharacter(char... allowed)
|
java.lang.String |
readLine()
Read the next line and return the contents of the buffer. |
java.lang.String |
readLine(java.lang.Character mask)
Read the next line with the specified character mask. |
java.lang.String |
readLine(java.lang.String prompt)
|
java.lang.String |
readLine(java.lang.String prompt,
java.lang.Character mask)
Read a line from the in InputStream , and return the line
(without any trailing newlines). |
int |
readVirtualKey()
Read a character from the console. |
void |
redrawLine()
Clear the line and redraw it. |
boolean |
removeCompleter(Completer completer)
Remove the specified Completer from the list of handlers for tab-completion. |
boolean |
replace(int num,
java.lang.String replacement)
|
void |
resetPromptLine(java.lang.String prompt,
java.lang.String buffer,
int cursorDest)
Erases the current line with the existing prompt, then redraws the line with the provided prompt and buffer |
void |
restoreLine(java.lang.String originalPrompt,
int cursorDest)
|
int |
searchBackwards(java.lang.String searchTerm)
Search backwards in history from the current position. |
int |
searchBackwards(java.lang.String searchTerm,
int startIndex)
Search backward in history from a given position. |
int |
searchBackwards(java.lang.String searchTerm,
int startIndex,
boolean startsWith)
|
void |
setAutoprintThreshold(int threshold)
|
void |
setBellEnabled(boolean enabled)
|
void |
setCompletionHandler(CompletionHandler handler)
|
boolean |
setCursorPosition(int position)
Move the cursor position to the specified absolute index. |
void |
setEchoCharacter(java.lang.Character c)
Set the echo character. |
void |
setHistory(History history)
|
void |
setHistoryEnabled(boolean enabled)
Whether or not to add new commands to the history buffer. |
void |
setPaginationEnabled(boolean enabled)
Whether to use pagination when the number of rows of candidates exceeds the height of the terminal. |
void |
setPrompt(java.lang.String prompt)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String JLINE_NOBELL
public static final char BACKSPACE
public static final char RESET_LINE
public static final char KEYBOARD_BELL
public static final char NULL_MASK
public static final int TAB_WIDTH
public static final java.lang.String JLINE_COMPLETION_THRESHOLD
public static final java.lang.String JLINE_KEYBINDINGS
public static final java.lang.String JLINEBINDINGS_PROPERTIES
public static final java.lang.String CR
Constructor Detail |
---|
public ConsoleReader(java.io.InputStream in, java.io.Writer out, java.io.InputStream bindings, Terminal term) throws java.io.IOException
java.io.IOException
public ConsoleReader(java.io.InputStream in, java.io.Writer out, Terminal term) throws java.io.IOException
java.io.IOException
public ConsoleReader(java.io.InputStream in, java.io.Writer out) throws java.io.IOException
java.io.IOException
public ConsoleReader() throws java.io.IOException
FileDescriptor.in
for input and
System.out
for output.
FileDescriptor.in
is used because it has a better chance of not being buffered.
java.io.IOException
Method Detail |
---|
public java.io.InputStream getInput()
public java.io.Writer getOutput()
public Terminal getTerminal()
public CursorBuffer getCursorBuffer()
public void setBellEnabled(boolean enabled)
public boolean isBellEnabled()
public void setPrompt(java.lang.String prompt)
public java.lang.String getPrompt()
public void setEchoCharacter(java.lang.Character c)
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.
c
- the character to echo to the console in place of the typed character.public java.lang.Character getEchoCharacter()
public final boolean setCursorPosition(int position) throws java.io.IOException
java.io.IOException
public final void drawLine() throws java.io.IOException
java.io.IOException
public final void redrawLine() throws java.io.IOException
java.io.IOException
public final void putString(java.lang.CharSequence str) throws java.io.IOException
java.io.IOException
public void flush() throws java.io.IOException
java.io.IOException
public boolean backspace() throws java.io.IOException
java.io.IOException
public int moveCursor(int num) throws java.io.IOException
num
- If less than 0, move abs(where) to the left, otherwise move where to the right.
java.io.IOException
public final boolean replace(int num, java.lang.String replacement)
public final int readVirtualKey() throws java.io.IOException
java.io.IOException
public final int readCharacter(char... allowed) throws java.io.IOException
java.io.IOException
public java.lang.String readLine() throws java.io.IOException
java.io.IOException
public java.lang.String readLine(java.lang.Character mask) throws java.io.IOException
java.io.IOException
public java.lang.String readLine(java.lang.String prompt) throws java.io.IOException
java.io.IOException
public java.lang.String readLine(java.lang.String prompt, java.lang.Character mask) throws java.io.IOException
InputStream
, and return the line
(without any trailing newlines).
prompt
- The prompt to issue to the console, may be null.
java.io.IOException
public boolean addCompleter(Completer completer)
Completer
to the list of handlers for tab-completion.
completer
- the Completer
to add
public boolean removeCompleter(Completer completer)
Completer
from the list of handlers for tab-completion.
completer
- The Completer
to remove
public java.util.Collection<Completer> getCompleters()
public void setCompletionHandler(CompletionHandler handler)
public CompletionHandler getCompletionHandler()
public void setAutoprintThreshold(int threshold)
threshold
- the number of candidates to print without issuing a warning.public int getAutoprintThreshold()
public void setPaginationEnabled(boolean enabled)
public boolean isPaginationEnabled()
public void setHistory(History history)
public History getHistory()
public void setHistoryEnabled(boolean enabled)
public boolean isHistoryEnabled()
public final void print(java.lang.CharSequence s) throws java.io.IOException
java.io.IOException
public final void println(java.lang.CharSequence s) throws java.io.IOException
java.io.IOException
public final void println() throws java.io.IOException
java.io.IOException
public final boolean delete() throws java.io.IOException
java.io.IOException
public boolean killLine() throws java.io.IOException
java.io.IOException
public boolean clearScreen() throws java.io.IOException
java.io.IOException
public void beep() throws java.io.IOException
isBellEnabled()
return true.
java.io.IOException
public boolean paste() throws java.io.IOException
java.io.IOException
public void addTriggeredAction(char c, java.awt.event.ActionListener listener)
public void printColumns(java.util.Collection<? extends java.lang.CharSequence> items) throws java.io.IOException
Collection
in proper columns.
java.io.IOException
public void resetPromptLine(java.lang.String prompt, java.lang.String buffer, int cursorDest) throws java.io.IOException
prompt
- the new promptbuffer
- the buffer to be drawncursorDest
- where you want the cursor set when the line has been drawn.
-1 for end of line.
java.io.IOException
public void printSearchStatus(java.lang.String searchTerm, java.lang.String match) throws java.io.IOException
java.io.IOException
public void restoreLine(java.lang.String originalPrompt, int cursorDest) throws java.io.IOException
java.io.IOException
public int searchBackwards(java.lang.String searchTerm, int startIndex)
searchTerm
- substring to search for.startIndex
- the index from which on to search
public int searchBackwards(java.lang.String searchTerm)
searchTerm
- substring to search for.
public int searchBackwards(java.lang.String searchTerm, int startIndex, boolean startsWith)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |