Package org.jline.reader
Interface LineReader
-
- All Known Implementing Classes:
LineReaderImpl
public interface LineReader
Read lines from the console, with input editing.Thread safety
TheLineReader
implementations are not thread safe, thus you should not attempt to use a single reader in several threads. Any attempt to call one of thereadLine
call while one is already executing in a different thread will immediately result in anIllegalStateException
being thrown. Other calls may lead to unknown behaviors. There is one exception though: users are allowed to callprintAbove(String)
orprintAbove(AttributedString)
at any time to allow text to be printed above the current prompt.Prompt strings
It is traditional for an interactive console-based program to print a short prompt string to signal that the user is expected to type a command. JLine supports 3 kinds of prompt string:- The normal prompt at the start (left) of the initial line of a command.
- An optional right prompt at the right border of the initial line.
- A start (left) prompt for continuation lines. I.e. the lines after the first line of a multi-line command.
All of these are specified with prompt templates, which are similar to
The pattern may include ANSI escapes. It may include these template markers:printf
format strings, using the character'%'
to indicate special functionality.%N
- A line number. This is the sum of
getLineNumber()
and a counter starting with 1 for the first continuation line. %M
- A short word explaining what is "missing". This is supplied from
the
EOFError.getMissing()
method, if provided. Defaults to an empty string. %
nP
c- Insert padding at this position, repeating the following character c as needed to bring the total prompt column width as specified by the digits n.
%P
c- As before, but use width from the initial prompt.
%%
- A literal
'%'
. %{
%}
- Text between a
%{
...%}
pair is printed as part of a prompt, but not interpreted by JLine (except that'%'
-escapes are processed). The text is assumed to take zero columns (not move the cursor). If it changes the style, you're responsible for changing it back. Standard ANSI escape sequences do not need to be within a%{
...%}
pair (though can be) since JLine knows how to deal with them. However, these delimiters are needed for unusual non-standard escape sequences.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
LineReader.Option
static class
LineReader.RegionType
static class
LineReader.SuggestionType
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ACCEPT_AND_HOLD
static java.lang.String
ACCEPT_AND_INFER_NEXT_HISTORY
static java.lang.String
ACCEPT_LINE
static java.lang.String
ACCEPT_LINE_AND_DOWN_HISTORY
static java.lang.String
AMBIGUOUS_BINDING
Timeout for ambiguous key sequences.static java.lang.String
ARGUMENT_BASE
static java.lang.String
BACKWARD_CHAR
static java.lang.String
BACKWARD_DELETE_CHAR
static java.lang.String
BACKWARD_DELETE_WORD
static java.lang.String
BACKWARD_KILL_LINE
static java.lang.String
BACKWARD_KILL_WORD
static java.lang.String
BACKWARD_WORD
static java.lang.String
BEEP
static java.lang.String
BEGIN_PASTE
static java.lang.String
BEGINNING_OF_BUFFER_OR_HISTORY
static java.lang.String
BEGINNING_OF_HISTORY
static java.lang.String
BEGINNING_OF_LINE
static java.lang.String
BEGINNING_OF_LINE_HIST
static java.lang.String
BELL_STYLE
static java.lang.String
BIND_TTY_SPECIAL_CHARS
static java.lang.String
BLINK_MATCHING_PAREN
static java.lang.String
CALLBACK_FINISH
static java.lang.String
CALLBACK_INIT
static java.lang.String
CALLBACK_KEYMAP
static java.lang.String
CAPITALIZE_WORD
static java.lang.String
CHARACTER_SEARCH
static java.lang.String
CHARACTER_SEARCH_BACKWARD
static java.lang.String
CLEAR
static java.lang.String
CLEAR_SCREEN
static java.lang.String
COMMENT_BEGIN
static java.lang.String
COMPLETE_PREFIX
static java.lang.String
COMPLETE_WORD
static java.lang.String
COMPLETION_STYLE_BACKGROUND
Completion style for displaying the liststatic java.lang.String
COMPLETION_STYLE_DESCRIPTION
Completion style for displaying the candidate descriptionstatic java.lang.String
COMPLETION_STYLE_GROUP
Completion style for displaying groups namestatic java.lang.String
COMPLETION_STYLE_LIST_BACKGROUND
static java.lang.String
COMPLETION_STYLE_LIST_DESCRIPTION
static java.lang.String
COMPLETION_STYLE_LIST_GROUP
static java.lang.String
COMPLETION_STYLE_LIST_SELECTION
static java.lang.String
COMPLETION_STYLE_LIST_STARTING
static java.lang.String
COMPLETION_STYLE_SELECTION
Completion style for displaying the current selected itemstatic java.lang.String
COMPLETION_STYLE_STARTING
Completion style for displaying the matching part of candidatesstatic java.lang.String
COPY_PREV_WORD
static java.lang.String
COPY_REGION_AS_KILL
static java.lang.String
DELETE_CHAR
static java.lang.String
DELETE_CHAR_OR_LIST
static java.lang.String
DELETE_WORD
static java.lang.String
DIGIT_ARGUMENT
static java.lang.String
DISABLE_COMPLETION
static java.lang.String
DISABLE_HISTORY
static java.lang.String
DO_LOWERCASE_VERSION
static java.lang.String
DOWN_CASE_WORD
static java.lang.String
DOWN_HISTORY
static java.lang.String
DOWN_LINE
static java.lang.String
DOWN_LINE_OR_HISTORY
static java.lang.String
DOWN_LINE_OR_SEARCH
static java.lang.String
DUMB
static java.lang.String
EDIT_AND_EXECUTE_COMMAND
static java.lang.String
EDITING_MODE
static java.lang.String
EMACS
static java.lang.String
EMACS_BACKWARD_WORD
static java.lang.String
EMACS_EDITING_MODE
static java.lang.String
EMACS_FORWARD_WORD
static java.lang.String
END_OF_BUFFER_OR_HISTORY
static java.lang.String
END_OF_HISTORY
static java.lang.String
END_OF_LINE
static java.lang.String
END_OF_LINE_HIST
static java.lang.String
ERRORS
Number of matching errors that are accepted by the completion matcherstatic java.lang.String
EXCHANGE_POINT_AND_MARK
static java.lang.String
EXECUTE_NAMED_CMD
static java.lang.String
EXPAND_HISTORY
static java.lang.String
EXPAND_OR_COMPLETE
static java.lang.String
EXPAND_OR_COMPLETE_PREFIX
static java.lang.String
EXPAND_WORD
static java.lang.String
FEATURES_MAX_BUFFER_SIZE
Max buffer size for advanced features.static java.lang.String
FOCUS_IN
static java.lang.String
FOCUS_OUT
static java.lang.String
FORWARD_CHAR
static java.lang.String
FORWARD_WORD
static java.lang.String
FRESH_LINE
static java.lang.String
HISTORY_BEGINNING_SEARCH_BACKWARD
static java.lang.String
HISTORY_BEGINNING_SEARCH_FORWARD
static java.lang.String
HISTORY_FILE
File system history path.static java.lang.String
HISTORY_FILE_SIZE
Number of history items to keep in the history file.static java.lang.String
HISTORY_IGNORE
Colon separated list of patterns that will not be saved in history.static java.lang.String
HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD
static java.lang.String
HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD
static java.lang.String
HISTORY_INCREMENTAL_SEARCH_BACKWARD
static java.lang.String
HISTORY_INCREMENTAL_SEARCH_FORWARD
static java.lang.String
HISTORY_SEARCH_BACKWARD
static java.lang.String
HISTORY_SEARCH_FORWARD
static java.lang.String
HISTORY_SIZE
Number of history items to keep in memory.static java.lang.String
INDENTATION
New line automatic indentation after opening/closing bracket.static java.lang.String
INFER_NEXT_HISTORY
static java.lang.String
INPUT_RC_FILE_NAME
Name of inputrc to read at line reader creation time.static java.lang.String
INSERT_CLOSE_CURLY
static java.lang.String
INSERT_CLOSE_PAREN
static java.lang.String
INSERT_CLOSE_SQUARE
static java.lang.String
INSERT_COMMENT
static java.lang.String
INSERT_LAST_WORD
static java.lang.String
KEYMAP
static java.lang.String
KILL_BUFFER
static java.lang.String
KILL_LINE
static java.lang.String
KILL_REGION
static java.lang.String
KILL_WHOLE_LINE
static java.lang.String
KILL_WORD
static java.lang.String
LINE_OFFSET
When in multiline edit mode, this variable can be used to offset the line number displayed.static java.lang.String
LIST_CHOICES
static java.lang.String
LIST_EXPAND
static java.lang.String
LIST_MAX
tab completion: if candidates are more than list-max a question will be asked before displaying themstatic java.lang.String
MAGIC_SPACE
static java.lang.String
MAIN
static java.lang.String
MAX_REPEAT_COUNT
Max number of times a command can be repeated.static java.lang.String
MENU
static java.lang.String
MENU_COMPLETE
static java.lang.String
MENU_EXPAND_OR_COMPLETE
static java.lang.String
MENU_LIST_MAX
tab completion: if candidates are less than menu-list-max they are displayed in a list below the field to be completedstatic java.lang.String
MENU_SELECT
static java.lang.String
MOUSE
static java.lang.String
NEG_ARGUMENT
static java.lang.String
ORIGINAL_GROUP_NAME
Property for the "original" group namestatic java.lang.String
OTHERS_GROUP_NAME
Property for the "others" group namestatic java.lang.String
OVERWRITE_MODE
static java.lang.String
PREFER_VISIBLE_BELL
static java.lang.String
PROP_SUPPORT_PARSEDLINE
System property that can be set to avoid a warning being logged when using a Parser which does not returnCompletingParsedLine
objects.static java.lang.String
PUT_REPLACE_SELECTION
static java.lang.String
QUOTED_INSERT
static java.lang.String
READ_COMMAND
static java.lang.String
RECURSIVE_EDIT
static java.lang.String
REDISPLAY
static java.lang.String
REDO
static java.lang.String
REDRAW_LINE
static java.lang.String
REMOVE_SUFFIX_CHARS
static java.lang.String
REVERSE_MENU_COMPLETE
static java.lang.String
SAFE
static java.lang.String
SEARCH_TERMINATORS
static java.lang.String
SECONDARY_PROMPT_PATTERN
Set the template for prompts for secondary (continuation) lines.static java.lang.String
SELF_INSERT
static java.lang.String
SELF_INSERT_UNMETA
static java.lang.String
SEND_BREAK
static java.lang.String
SET_LOCAL_HISTORY
static java.lang.String
SET_MARK_COMMAND
static java.lang.String
SPELL_WORD
static java.lang.String
SPLIT_UNDO
static java.lang.String
SUGGESTIONS_MIN_BUFFER_SIZE
Min buffer size for tab auto-suggestions.static java.lang.String
SYSTEM_PROPERTY_PREFIX
Prefix to automatically delegate variables to system propertiesstatic java.lang.String
TAB_WIDTH
Number of spaces to display a tabulation, the default is 4.static java.lang.String
TRANSPOSE_CHARS
static java.lang.String
TRANSPOSE_WORDS
static java.lang.String
UNDEFINED_KEY
static java.lang.String
UNDO
static java.lang.String
UNIVERSAL_ARGUMENT
static java.lang.String
UP_CASE_WORD
static java.lang.String
UP_HISTORY
static java.lang.String
UP_LINE
static java.lang.String
UP_LINE_OR_HISTORY
static java.lang.String
UP_LINE_OR_SEARCH
static java.lang.String
VI_ADD_EOL
static java.lang.String
VI_ADD_NEXT
static java.lang.String
VI_BACKWARD_BLANK_WORD
static java.lang.String
VI_BACKWARD_BLANK_WORD_END
static java.lang.String
VI_BACKWARD_CHAR
static java.lang.String
VI_BACKWARD_DELETE_CHAR
static java.lang.String
VI_BACKWARD_KILL_WORD
static java.lang.String
VI_BACKWARD_WORD
static java.lang.String
VI_BACKWARD_WORD_END
static java.lang.String
VI_BEGINNING_OF_LINE
static java.lang.String
VI_CHANGE
static java.lang.String
VI_CHANGE_EOL
static java.lang.String
VI_CHANGE_WHOLE_LINE
static java.lang.String
VI_CMD_MODE
static java.lang.String
VI_DELETE
static java.lang.String
VI_DELETE_CHAR
static java.lang.String
VI_DIGIT_OR_BEGINNING_OF_LINE
static java.lang.String
VI_DOWN_LINE_OR_HISTORY
static java.lang.String
VI_END_OF_LINE
static java.lang.String
VI_FETCH_HISTORY
static java.lang.String
VI_FIND_NEXT_CHAR
static java.lang.String
VI_FIND_NEXT_CHAR_SKIP
static java.lang.String
VI_FIND_PREV_CHAR
static java.lang.String
VI_FIND_PREV_CHAR_SKIP
static java.lang.String
VI_FIRST_NON_BLANK
static java.lang.String
VI_FORWARD_BLANK_WORD
static java.lang.String
VI_FORWARD_BLANK_WORD_END
static java.lang.String
VI_FORWARD_CHAR
static java.lang.String
VI_FORWARD_WORD
static java.lang.String
VI_FORWARD_WORD_END
static java.lang.String
VI_GOTO_COLUMN
static java.lang.String
VI_HISTORY_SEARCH_BACKWARD
static java.lang.String
VI_HISTORY_SEARCH_FORWARD
static java.lang.String
VI_INSERT
static java.lang.String
VI_INSERT_BOL
static java.lang.String
VI_INSERT_COMMENT
static java.lang.String
VI_JOIN
static java.lang.String
VI_KILL_EOL
static java.lang.String
VI_KILL_LINE
static java.lang.String
VI_MATCH_BRACKET
static java.lang.String
VI_OPEN_LINE_ABOVE
static java.lang.String
VI_OPEN_LINE_BELOW
static java.lang.String
VI_OPER_SWAP_CASE
static java.lang.String
VI_PUT_AFTER
static java.lang.String
VI_PUT_BEFORE
static java.lang.String
VI_QUOTED_INSERT
static java.lang.String
VI_REPEAT_CHANGE
static java.lang.String
VI_REPEAT_FIND
static java.lang.String
VI_REPEAT_SEARCH
static java.lang.String
VI_REPLACE
static java.lang.String
VI_REPLACE_CHARS
static java.lang.String
VI_REV_REPEAT_FIND
static java.lang.String
VI_REV_REPEAT_SEARCH
static java.lang.String
VI_SET_BUFFER
static java.lang.String
VI_SUBSTITUTE
static java.lang.String
VI_SWAP_CASE
static java.lang.String
VI_UNDO_CHANGE
static java.lang.String
VI_UP_LINE_OR_HISTORY
static java.lang.String
VI_YANK
static java.lang.String
VI_YANK_EOL
static java.lang.String
VI_YANK_WHOLE_LINE
static java.lang.String
VICMD
static java.lang.String
VIINS
static java.lang.String
VIOPP
static java.lang.String
VISUAL
static java.lang.String
VISUAL_LINE_MODE
static java.lang.String
VISUAL_MODE
static java.lang.String
WHAT_CURSOR_POSITION
static java.lang.String
WORDCHARS
static java.lang.String
YANK
static java.lang.String
YANK_POP
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
addCommandsInBuffer(java.util.Collection<java.lang.String> commands)
void
callWidget(java.lang.String name)
java.util.Map<java.lang.String,KeyMap<Binding>>
defaultKeyMaps()
default void
editAndAddInBuffer(java.io.File file)
void
editAndAddInBuffer(java.nio.file.Path file)
java.lang.String
getAppName()
LineReader.SuggestionType
getAutosuggestion()
Buffer
getBuffer()
java.util.Map<java.lang.String,Widget>
getBuiltinWidgets()
Expander
getExpander()
Highlighter
getHighlighter()
History
getHistory()
java.lang.String
getKeyMap()
java.util.Map<java.lang.String,KeyMap<Binding>>
getKeyMaps()
KeyMap<Binding>
getKeys()
java.lang.String
getLastBinding()
ParsedLine
getParsedLine()
Parser
getParser()
LineReader.RegionType
getRegionActive()
int
getRegionMark()
java.lang.String
getSearchTerm()
java.lang.String
getTailTip()
Terminal
getTerminal()
java.lang.Object
getVariable(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>
getVariables()
java.util.Map<java.lang.String,Widget>
getWidgets()
boolean
isReading()
Check if a thread is currently in areadLine()
call.boolean
isSet(LineReader.Option option)
LineReader
option(LineReader.Option option, boolean value)
void
printAbove(java.lang.String str)
Prints a line above the prompt and redraw everything.void
printAbove(AttributedString str)
Prints a string before the prompt and redraw everything.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)
Read the next line with the specified prompt.java.lang.String
readLine(java.lang.String prompt, java.lang.Character mask)
Read a line from the inInputStream
, and return the line (without any trailing newlines).java.lang.String
readLine(java.lang.String prompt, java.lang.Character mask, java.lang.String buffer)
Read a line from the inInputStream
, and return the line (without any trailing newlines).java.lang.String
readLine(java.lang.String prompt, java.lang.String rightPrompt, java.lang.Character mask, java.lang.String buffer)
Read a line from the inInputStream
, and return the line (without any trailing newlines).java.lang.String
readLine(java.lang.String prompt, java.lang.String rightPrompt, MaskingCallback maskingCallback, java.lang.String buffer)
Read a line from the inInputStream
, and return the line (without any trailing newlines).MouseEvent
readMouseEvent()
Read a mouse event when theInfoCmp.Capability.key_mouse
sequence has just been read on the input stream.void
runMacro(java.lang.String macro)
Push back a key sequence that will be later consumed by the line reader.void
setAutosuggestion(LineReader.SuggestionType type)
boolean
setKeyMap(java.lang.String name)
void
setOpt(LineReader.Option option)
void
setTailTip(java.lang.String tailTip)
void
setVariable(java.lang.String name, java.lang.Object value)
void
unsetOpt(LineReader.Option option)
LineReader
variable(java.lang.String name, java.lang.Object value)
void
zeroOut()
Clear any internal buffers.
-
-
-
Field Detail
-
PROP_SUPPORT_PARSEDLINE
static final java.lang.String PROP_SUPPORT_PARSEDLINE
System property that can be set to avoid a warning being logged when using a Parser which does not returnCompletingParsedLine
objects.- See Also:
- Constant Field Values
-
CALLBACK_INIT
static final java.lang.String CALLBACK_INIT
- See Also:
- Constant Field Values
-
CALLBACK_FINISH
static final java.lang.String CALLBACK_FINISH
- See Also:
- Constant Field Values
-
CALLBACK_KEYMAP
static final java.lang.String CALLBACK_KEYMAP
- See Also:
- Constant Field Values
-
ACCEPT_AND_INFER_NEXT_HISTORY
static final java.lang.String ACCEPT_AND_INFER_NEXT_HISTORY
- See Also:
- Constant Field Values
-
ACCEPT_AND_HOLD
static final java.lang.String ACCEPT_AND_HOLD
- See Also:
- Constant Field Values
-
ACCEPT_LINE
static final java.lang.String ACCEPT_LINE
- See Also:
- Constant Field Values
-
ACCEPT_LINE_AND_DOWN_HISTORY
static final java.lang.String ACCEPT_LINE_AND_DOWN_HISTORY
- See Also:
- Constant Field Values
-
ARGUMENT_BASE
static final java.lang.String ARGUMENT_BASE
- See Also:
- Constant Field Values
-
BACKWARD_CHAR
static final java.lang.String BACKWARD_CHAR
- See Also:
- Constant Field Values
-
BACKWARD_DELETE_CHAR
static final java.lang.String BACKWARD_DELETE_CHAR
- See Also:
- Constant Field Values
-
BACKWARD_DELETE_WORD
static final java.lang.String BACKWARD_DELETE_WORD
- See Also:
- Constant Field Values
-
BACKWARD_KILL_LINE
static final java.lang.String BACKWARD_KILL_LINE
- See Also:
- Constant Field Values
-
BACKWARD_KILL_WORD
static final java.lang.String BACKWARD_KILL_WORD
- See Also:
- Constant Field Values
-
BACKWARD_WORD
static final java.lang.String BACKWARD_WORD
- See Also:
- Constant Field Values
-
BEEP
static final java.lang.String BEEP
- See Also:
- Constant Field Values
-
BEGINNING_OF_BUFFER_OR_HISTORY
static final java.lang.String BEGINNING_OF_BUFFER_OR_HISTORY
- See Also:
- Constant Field Values
-
BEGINNING_OF_HISTORY
static final java.lang.String BEGINNING_OF_HISTORY
- See Also:
- Constant Field Values
-
BEGINNING_OF_LINE
static final java.lang.String BEGINNING_OF_LINE
- See Also:
- Constant Field Values
-
BEGINNING_OF_LINE_HIST
static final java.lang.String BEGINNING_OF_LINE_HIST
- See Also:
- Constant Field Values
-
CAPITALIZE_WORD
static final java.lang.String CAPITALIZE_WORD
- See Also:
- Constant Field Values
-
CHARACTER_SEARCH
static final java.lang.String CHARACTER_SEARCH
- See Also:
- Constant Field Values
-
CHARACTER_SEARCH_BACKWARD
static final java.lang.String CHARACTER_SEARCH_BACKWARD
- See Also:
- Constant Field Values
-
CLEAR
static final java.lang.String CLEAR
- See Also:
- Constant Field Values
-
CLEAR_SCREEN
static final java.lang.String CLEAR_SCREEN
- See Also:
- Constant Field Values
-
COMPLETE_PREFIX
static final java.lang.String COMPLETE_PREFIX
- See Also:
- Constant Field Values
-
COMPLETE_WORD
static final java.lang.String COMPLETE_WORD
- See Also:
- Constant Field Values
-
COPY_PREV_WORD
static final java.lang.String COPY_PREV_WORD
- See Also:
- Constant Field Values
-
COPY_REGION_AS_KILL
static final java.lang.String COPY_REGION_AS_KILL
- See Also:
- Constant Field Values
-
DELETE_CHAR
static final java.lang.String DELETE_CHAR
- See Also:
- Constant Field Values
-
DELETE_CHAR_OR_LIST
static final java.lang.String DELETE_CHAR_OR_LIST
- See Also:
- Constant Field Values
-
DELETE_WORD
static final java.lang.String DELETE_WORD
- See Also:
- Constant Field Values
-
DIGIT_ARGUMENT
static final java.lang.String DIGIT_ARGUMENT
- See Also:
- Constant Field Values
-
DO_LOWERCASE_VERSION
static final java.lang.String DO_LOWERCASE_VERSION
- See Also:
- Constant Field Values
-
DOWN_CASE_WORD
static final java.lang.String DOWN_CASE_WORD
- See Also:
- Constant Field Values
-
DOWN_HISTORY
static final java.lang.String DOWN_HISTORY
- See Also:
- Constant Field Values
-
DOWN_LINE
static final java.lang.String DOWN_LINE
- See Also:
- Constant Field Values
-
DOWN_LINE_OR_HISTORY
static final java.lang.String DOWN_LINE_OR_HISTORY
- See Also:
- Constant Field Values
-
DOWN_LINE_OR_SEARCH
static final java.lang.String DOWN_LINE_OR_SEARCH
- See Also:
- Constant Field Values
-
EDIT_AND_EXECUTE_COMMAND
static final java.lang.String EDIT_AND_EXECUTE_COMMAND
- See Also:
- Constant Field Values
-
EMACS_BACKWARD_WORD
static final java.lang.String EMACS_BACKWARD_WORD
- See Also:
- Constant Field Values
-
EMACS_EDITING_MODE
static final java.lang.String EMACS_EDITING_MODE
- See Also:
- Constant Field Values
-
EMACS_FORWARD_WORD
static final java.lang.String EMACS_FORWARD_WORD
- See Also:
- Constant Field Values
-
END_OF_BUFFER_OR_HISTORY
static final java.lang.String END_OF_BUFFER_OR_HISTORY
- See Also:
- Constant Field Values
-
END_OF_HISTORY
static final java.lang.String END_OF_HISTORY
- See Also:
- Constant Field Values
-
END_OF_LINE
static final java.lang.String END_OF_LINE
- See Also:
- Constant Field Values
-
END_OF_LINE_HIST
static final java.lang.String END_OF_LINE_HIST
- See Also:
- Constant Field Values
-
EXCHANGE_POINT_AND_MARK
static final java.lang.String EXCHANGE_POINT_AND_MARK
- See Also:
- Constant Field Values
-
EXECUTE_NAMED_CMD
static final java.lang.String EXECUTE_NAMED_CMD
- See Also:
- Constant Field Values
-
EXPAND_HISTORY
static final java.lang.String EXPAND_HISTORY
- See Also:
- Constant Field Values
-
EXPAND_OR_COMPLETE
static final java.lang.String EXPAND_OR_COMPLETE
- See Also:
- Constant Field Values
-
EXPAND_OR_COMPLETE_PREFIX
static final java.lang.String EXPAND_OR_COMPLETE_PREFIX
- See Also:
- Constant Field Values
-
EXPAND_WORD
static final java.lang.String EXPAND_WORD
- See Also:
- Constant Field Values
-
FRESH_LINE
static final java.lang.String FRESH_LINE
- See Also:
- Constant Field Values
-
FORWARD_CHAR
static final java.lang.String FORWARD_CHAR
- See Also:
- Constant Field Values
-
FORWARD_WORD
static final java.lang.String FORWARD_WORD
- See Also:
- Constant Field Values
-
HISTORY_BEGINNING_SEARCH_BACKWARD
static final java.lang.String HISTORY_BEGINNING_SEARCH_BACKWARD
- See Also:
- Constant Field Values
-
HISTORY_BEGINNING_SEARCH_FORWARD
static final java.lang.String HISTORY_BEGINNING_SEARCH_FORWARD
- See Also:
- Constant Field Values
-
HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD
static final java.lang.String HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD
- See Also:
- Constant Field Values
-
HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD
static final java.lang.String HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD
- See Also:
- Constant Field Values
-
HISTORY_INCREMENTAL_SEARCH_BACKWARD
static final java.lang.String HISTORY_INCREMENTAL_SEARCH_BACKWARD
- See Also:
- Constant Field Values
-
HISTORY_INCREMENTAL_SEARCH_FORWARD
static final java.lang.String HISTORY_INCREMENTAL_SEARCH_FORWARD
- See Also:
- Constant Field Values
-
HISTORY_SEARCH_BACKWARD
static final java.lang.String HISTORY_SEARCH_BACKWARD
- See Also:
- Constant Field Values
-
HISTORY_SEARCH_FORWARD
static final java.lang.String HISTORY_SEARCH_FORWARD
- See Also:
- Constant Field Values
-
INSERT_CLOSE_CURLY
static final java.lang.String INSERT_CLOSE_CURLY
- See Also:
- Constant Field Values
-
INSERT_CLOSE_PAREN
static final java.lang.String INSERT_CLOSE_PAREN
- See Also:
- Constant Field Values
-
INSERT_CLOSE_SQUARE
static final java.lang.String INSERT_CLOSE_SQUARE
- See Also:
- Constant Field Values
-
INFER_NEXT_HISTORY
static final java.lang.String INFER_NEXT_HISTORY
- See Also:
- Constant Field Values
-
INSERT_COMMENT
static final java.lang.String INSERT_COMMENT
- See Also:
- Constant Field Values
-
INSERT_LAST_WORD
static final java.lang.String INSERT_LAST_WORD
- See Also:
- Constant Field Values
-
KILL_BUFFER
static final java.lang.String KILL_BUFFER
- See Also:
- Constant Field Values
-
KILL_LINE
static final java.lang.String KILL_LINE
- See Also:
- Constant Field Values
-
KILL_REGION
static final java.lang.String KILL_REGION
- See Also:
- Constant Field Values
-
KILL_WHOLE_LINE
static final java.lang.String KILL_WHOLE_LINE
- See Also:
- Constant Field Values
-
KILL_WORD
static final java.lang.String KILL_WORD
- See Also:
- Constant Field Values
-
LIST_CHOICES
static final java.lang.String LIST_CHOICES
- See Also:
- Constant Field Values
-
LIST_EXPAND
static final java.lang.String LIST_EXPAND
- See Also:
- Constant Field Values
-
MAGIC_SPACE
static final java.lang.String MAGIC_SPACE
- See Also:
- Constant Field Values
-
MENU_EXPAND_OR_COMPLETE
static final java.lang.String MENU_EXPAND_OR_COMPLETE
- See Also:
- Constant Field Values
-
MENU_COMPLETE
static final java.lang.String MENU_COMPLETE
- See Also:
- Constant Field Values
-
MENU_SELECT
static final java.lang.String MENU_SELECT
- See Also:
- Constant Field Values
-
NEG_ARGUMENT
static final java.lang.String NEG_ARGUMENT
- See Also:
- Constant Field Values
-
OVERWRITE_MODE
static final java.lang.String OVERWRITE_MODE
- See Also:
- Constant Field Values
-
PUT_REPLACE_SELECTION
static final java.lang.String PUT_REPLACE_SELECTION
- See Also:
- Constant Field Values
-
QUOTED_INSERT
static final java.lang.String QUOTED_INSERT
- See Also:
- Constant Field Values
-
READ_COMMAND
static final java.lang.String READ_COMMAND
- See Also:
- Constant Field Values
-
RECURSIVE_EDIT
static final java.lang.String RECURSIVE_EDIT
- See Also:
- Constant Field Values
-
REDISPLAY
static final java.lang.String REDISPLAY
- See Also:
- Constant Field Values
-
REDRAW_LINE
static final java.lang.String REDRAW_LINE
- See Also:
- Constant Field Values
-
REDO
static final java.lang.String REDO
- See Also:
- Constant Field Values
-
REVERSE_MENU_COMPLETE
static final java.lang.String REVERSE_MENU_COMPLETE
- See Also:
- Constant Field Values
-
SELF_INSERT
static final java.lang.String SELF_INSERT
- See Also:
- Constant Field Values
-
SELF_INSERT_UNMETA
static final java.lang.String SELF_INSERT_UNMETA
- See Also:
- Constant Field Values
-
SEND_BREAK
static final java.lang.String SEND_BREAK
- See Also:
- Constant Field Values
-
SET_LOCAL_HISTORY
static final java.lang.String SET_LOCAL_HISTORY
- See Also:
- Constant Field Values
-
SET_MARK_COMMAND
static final java.lang.String SET_MARK_COMMAND
- See Also:
- Constant Field Values
-
SPELL_WORD
static final java.lang.String SPELL_WORD
- See Also:
- Constant Field Values
-
SPLIT_UNDO
static final java.lang.String SPLIT_UNDO
- See Also:
- Constant Field Values
-
TRANSPOSE_CHARS
static final java.lang.String TRANSPOSE_CHARS
- See Also:
- Constant Field Values
-
TRANSPOSE_WORDS
static final java.lang.String TRANSPOSE_WORDS
- See Also:
- Constant Field Values
-
UNDEFINED_KEY
static final java.lang.String UNDEFINED_KEY
- See Also:
- Constant Field Values
-
UNDO
static final java.lang.String UNDO
- See Also:
- Constant Field Values
-
UNIVERSAL_ARGUMENT
static final java.lang.String UNIVERSAL_ARGUMENT
- See Also:
- Constant Field Values
-
UP_CASE_WORD
static final java.lang.String UP_CASE_WORD
- See Also:
- Constant Field Values
-
UP_HISTORY
static final java.lang.String UP_HISTORY
- See Also:
- Constant Field Values
-
UP_LINE
static final java.lang.String UP_LINE
- See Also:
- Constant Field Values
-
UP_LINE_OR_HISTORY
static final java.lang.String UP_LINE_OR_HISTORY
- See Also:
- Constant Field Values
-
UP_LINE_OR_SEARCH
static final java.lang.String UP_LINE_OR_SEARCH
- See Also:
- Constant Field Values
-
VI_ADD_EOL
static final java.lang.String VI_ADD_EOL
- See Also:
- Constant Field Values
-
VI_ADD_NEXT
static final java.lang.String VI_ADD_NEXT
- See Also:
- Constant Field Values
-
VI_BACKWARD_BLANK_WORD
static final java.lang.String VI_BACKWARD_BLANK_WORD
- See Also:
- Constant Field Values
-
VI_BACKWARD_BLANK_WORD_END
static final java.lang.String VI_BACKWARD_BLANK_WORD_END
- See Also:
- Constant Field Values
-
VI_BACKWARD_CHAR
static final java.lang.String VI_BACKWARD_CHAR
- See Also:
- Constant Field Values
-
VI_BACKWARD_DELETE_CHAR
static final java.lang.String VI_BACKWARD_DELETE_CHAR
- See Also:
- Constant Field Values
-
VI_BACKWARD_KILL_WORD
static final java.lang.String VI_BACKWARD_KILL_WORD
- See Also:
- Constant Field Values
-
VI_BACKWARD_WORD
static final java.lang.String VI_BACKWARD_WORD
- See Also:
- Constant Field Values
-
VI_BACKWARD_WORD_END
static final java.lang.String VI_BACKWARD_WORD_END
- See Also:
- Constant Field Values
-
VI_BEGINNING_OF_LINE
static final java.lang.String VI_BEGINNING_OF_LINE
- See Also:
- Constant Field Values
-
VI_CHANGE
static final java.lang.String VI_CHANGE
- See Also:
- Constant Field Values
-
VI_CHANGE_EOL
static final java.lang.String VI_CHANGE_EOL
- See Also:
- Constant Field Values
-
VI_CHANGE_WHOLE_LINE
static final java.lang.String VI_CHANGE_WHOLE_LINE
- See Also:
- Constant Field Values
-
VI_CMD_MODE
static final java.lang.String VI_CMD_MODE
- See Also:
- Constant Field Values
-
VI_DELETE
static final java.lang.String VI_DELETE
- See Also:
- Constant Field Values
-
VI_DELETE_CHAR
static final java.lang.String VI_DELETE_CHAR
- See Also:
- Constant Field Values
-
VI_DIGIT_OR_BEGINNING_OF_LINE
static final java.lang.String VI_DIGIT_OR_BEGINNING_OF_LINE
- See Also:
- Constant Field Values
-
VI_DOWN_LINE_OR_HISTORY
static final java.lang.String VI_DOWN_LINE_OR_HISTORY
- See Also:
- Constant Field Values
-
VI_END_OF_LINE
static final java.lang.String VI_END_OF_LINE
- See Also:
- Constant Field Values
-
VI_FETCH_HISTORY
static final java.lang.String VI_FETCH_HISTORY
- See Also:
- Constant Field Values
-
VI_FIND_NEXT_CHAR
static final java.lang.String VI_FIND_NEXT_CHAR
- See Also:
- Constant Field Values
-
VI_FIND_NEXT_CHAR_SKIP
static final java.lang.String VI_FIND_NEXT_CHAR_SKIP
- See Also:
- Constant Field Values
-
VI_FIND_PREV_CHAR
static final java.lang.String VI_FIND_PREV_CHAR
- See Also:
- Constant Field Values
-
VI_FIND_PREV_CHAR_SKIP
static final java.lang.String VI_FIND_PREV_CHAR_SKIP
- See Also:
- Constant Field Values
-
VI_FIRST_NON_BLANK
static final java.lang.String VI_FIRST_NON_BLANK
- See Also:
- Constant Field Values
-
VI_FORWARD_BLANK_WORD
static final java.lang.String VI_FORWARD_BLANK_WORD
- See Also:
- Constant Field Values
-
VI_FORWARD_BLANK_WORD_END
static final java.lang.String VI_FORWARD_BLANK_WORD_END
- See Also:
- Constant Field Values
-
VI_FORWARD_CHAR
static final java.lang.String VI_FORWARD_CHAR
- See Also:
- Constant Field Values
-
VI_FORWARD_WORD
static final java.lang.String VI_FORWARD_WORD
- See Also:
- Constant Field Values
-
VI_FORWARD_WORD_END
static final java.lang.String VI_FORWARD_WORD_END
- See Also:
- Constant Field Values
-
VI_GOTO_COLUMN
static final java.lang.String VI_GOTO_COLUMN
- See Also:
- Constant Field Values
-
VI_HISTORY_SEARCH_BACKWARD
static final java.lang.String VI_HISTORY_SEARCH_BACKWARD
- See Also:
- Constant Field Values
-
VI_HISTORY_SEARCH_FORWARD
static final java.lang.String VI_HISTORY_SEARCH_FORWARD
- See Also:
- Constant Field Values
-
VI_INSERT
static final java.lang.String VI_INSERT
- See Also:
- Constant Field Values
-
VI_INSERT_BOL
static final java.lang.String VI_INSERT_BOL
- See Also:
- Constant Field Values
-
VI_INSERT_COMMENT
static final java.lang.String VI_INSERT_COMMENT
- See Also:
- Constant Field Values
-
VI_JOIN
static final java.lang.String VI_JOIN
- See Also:
- Constant Field Values
-
VI_KILL_EOL
static final java.lang.String VI_KILL_EOL
- See Also:
- Constant Field Values
-
VI_KILL_LINE
static final java.lang.String VI_KILL_LINE
- See Also:
- Constant Field Values
-
VI_MATCH_BRACKET
static final java.lang.String VI_MATCH_BRACKET
- See Also:
- Constant Field Values
-
VI_OPEN_LINE_ABOVE
static final java.lang.String VI_OPEN_LINE_ABOVE
- See Also:
- Constant Field Values
-
VI_OPEN_LINE_BELOW
static final java.lang.String VI_OPEN_LINE_BELOW
- See Also:
- Constant Field Values
-
VI_OPER_SWAP_CASE
static final java.lang.String VI_OPER_SWAP_CASE
- See Also:
- Constant Field Values
-
VI_PUT_AFTER
static final java.lang.String VI_PUT_AFTER
- See Also:
- Constant Field Values
-
VI_PUT_BEFORE
static final java.lang.String VI_PUT_BEFORE
- See Also:
- Constant Field Values
-
VI_QUOTED_INSERT
static final java.lang.String VI_QUOTED_INSERT
- See Also:
- Constant Field Values
-
VI_REPEAT_CHANGE
static final java.lang.String VI_REPEAT_CHANGE
- See Also:
- Constant Field Values
-
VI_REPEAT_FIND
static final java.lang.String VI_REPEAT_FIND
- See Also:
- Constant Field Values
-
VI_REPEAT_SEARCH
static final java.lang.String VI_REPEAT_SEARCH
- See Also:
- Constant Field Values
-
VI_REPLACE
static final java.lang.String VI_REPLACE
- See Also:
- Constant Field Values
-
VI_REPLACE_CHARS
static final java.lang.String VI_REPLACE_CHARS
- See Also:
- Constant Field Values
-
VI_REV_REPEAT_FIND
static final java.lang.String VI_REV_REPEAT_FIND
- See Also:
- Constant Field Values
-
VI_REV_REPEAT_SEARCH
static final java.lang.String VI_REV_REPEAT_SEARCH
- See Also:
- Constant Field Values
-
VI_SET_BUFFER
static final java.lang.String VI_SET_BUFFER
- See Also:
- Constant Field Values
-
VI_SUBSTITUTE
static final java.lang.String VI_SUBSTITUTE
- See Also:
- Constant Field Values
-
VI_SWAP_CASE
static final java.lang.String VI_SWAP_CASE
- See Also:
- Constant Field Values
-
VI_UNDO_CHANGE
static final java.lang.String VI_UNDO_CHANGE
- See Also:
- Constant Field Values
-
VI_UP_LINE_OR_HISTORY
static final java.lang.String VI_UP_LINE_OR_HISTORY
- See Also:
- Constant Field Values
-
VI_YANK
static final java.lang.String VI_YANK
- See Also:
- Constant Field Values
-
VI_YANK_EOL
static final java.lang.String VI_YANK_EOL
- See Also:
- Constant Field Values
-
VI_YANK_WHOLE_LINE
static final java.lang.String VI_YANK_WHOLE_LINE
- See Also:
- Constant Field Values
-
VISUAL_LINE_MODE
static final java.lang.String VISUAL_LINE_MODE
- See Also:
- Constant Field Values
-
VISUAL_MODE
static final java.lang.String VISUAL_MODE
- See Also:
- Constant Field Values
-
WHAT_CURSOR_POSITION
static final java.lang.String WHAT_CURSOR_POSITION
- See Also:
- Constant Field Values
-
YANK
static final java.lang.String YANK
- See Also:
- Constant Field Values
-
YANK_POP
static final java.lang.String YANK_POP
- See Also:
- Constant Field Values
-
MOUSE
static final java.lang.String MOUSE
- See Also:
- Constant Field Values
-
FOCUS_IN
static final java.lang.String FOCUS_IN
- See Also:
- Constant Field Values
-
FOCUS_OUT
static final java.lang.String FOCUS_OUT
- See Also:
- Constant Field Values
-
BEGIN_PASTE
static final java.lang.String BEGIN_PASTE
- See Also:
- Constant Field Values
-
VICMD
static final java.lang.String VICMD
- See Also:
- Constant Field Values
-
VIINS
static final java.lang.String VIINS
- See Also:
- Constant Field Values
-
VIOPP
static final java.lang.String VIOPP
- See Also:
- Constant Field Values
-
VISUAL
static final java.lang.String VISUAL
- See Also:
- Constant Field Values
-
MAIN
static final java.lang.String MAIN
- See Also:
- Constant Field Values
-
EMACS
static final java.lang.String EMACS
- See Also:
- Constant Field Values
-
SAFE
static final java.lang.String SAFE
- See Also:
- Constant Field Values
-
DUMB
static final java.lang.String DUMB
- See Also:
- Constant Field Values
-
MENU
static final java.lang.String MENU
- See Also:
- Constant Field Values
-
BIND_TTY_SPECIAL_CHARS
static final java.lang.String BIND_TTY_SPECIAL_CHARS
- See Also:
- Constant Field Values
-
COMMENT_BEGIN
static final java.lang.String COMMENT_BEGIN
- See Also:
- Constant Field Values
-
BELL_STYLE
static final java.lang.String BELL_STYLE
- See Also:
- Constant Field Values
-
PREFER_VISIBLE_BELL
static final java.lang.String PREFER_VISIBLE_BELL
- See Also:
- Constant Field Values
-
LIST_MAX
static final java.lang.String LIST_MAX
tab completion: if candidates are more than list-max a question will be asked before displaying them- See Also:
- Constant Field Values
-
MENU_LIST_MAX
static final java.lang.String MENU_LIST_MAX
tab completion: if candidates are less than menu-list-max they are displayed in a list below the field to be completed- See Also:
- Constant Field Values
-
DISABLE_HISTORY
static final java.lang.String DISABLE_HISTORY
- See Also:
- Constant Field Values
-
DISABLE_COMPLETION
static final java.lang.String DISABLE_COMPLETION
- See Also:
- Constant Field Values
-
EDITING_MODE
static final java.lang.String EDITING_MODE
- See Also:
- Constant Field Values
-
KEYMAP
static final java.lang.String KEYMAP
- See Also:
- Constant Field Values
-
BLINK_MATCHING_PAREN
static final java.lang.String BLINK_MATCHING_PAREN
- See Also:
- Constant Field Values
-
WORDCHARS
static final java.lang.String WORDCHARS
- See Also:
- Constant Field Values
-
REMOVE_SUFFIX_CHARS
static final java.lang.String REMOVE_SUFFIX_CHARS
- See Also:
- Constant Field Values
-
SEARCH_TERMINATORS
static final java.lang.String SEARCH_TERMINATORS
- See Also:
- Constant Field Values
-
ERRORS
static final java.lang.String ERRORS
Number of matching errors that are accepted by the completion matcher- See Also:
- Constant Field Values
-
OTHERS_GROUP_NAME
static final java.lang.String OTHERS_GROUP_NAME
Property for the "others" group name- See Also:
- Constant Field Values
-
ORIGINAL_GROUP_NAME
static final java.lang.String ORIGINAL_GROUP_NAME
Property for the "original" group name- See Also:
- Constant Field Values
-
COMPLETION_STYLE_GROUP
static final java.lang.String COMPLETION_STYLE_GROUP
Completion style for displaying groups name- See Also:
- Constant Field Values
-
COMPLETION_STYLE_LIST_GROUP
static final java.lang.String COMPLETION_STYLE_LIST_GROUP
- See Also:
- Constant Field Values
-
COMPLETION_STYLE_SELECTION
static final java.lang.String COMPLETION_STYLE_SELECTION
Completion style for displaying the current selected item- See Also:
- Constant Field Values
-
COMPLETION_STYLE_LIST_SELECTION
static final java.lang.String COMPLETION_STYLE_LIST_SELECTION
- See Also:
- Constant Field Values
-
COMPLETION_STYLE_DESCRIPTION
static final java.lang.String COMPLETION_STYLE_DESCRIPTION
Completion style for displaying the candidate description- See Also:
- Constant Field Values
-
COMPLETION_STYLE_LIST_DESCRIPTION
static final java.lang.String COMPLETION_STYLE_LIST_DESCRIPTION
- See Also:
- Constant Field Values
-
COMPLETION_STYLE_STARTING
static final java.lang.String COMPLETION_STYLE_STARTING
Completion style for displaying the matching part of candidates- See Also:
- Constant Field Values
-
COMPLETION_STYLE_LIST_STARTING
static final java.lang.String COMPLETION_STYLE_LIST_STARTING
- See Also:
- Constant Field Values
-
COMPLETION_STYLE_BACKGROUND
static final java.lang.String COMPLETION_STYLE_BACKGROUND
Completion style for displaying the list- See Also:
- Constant Field Values
-
COMPLETION_STYLE_LIST_BACKGROUND
static final java.lang.String COMPLETION_STYLE_LIST_BACKGROUND
- See Also:
- Constant Field Values
-
SECONDARY_PROMPT_PATTERN
static final java.lang.String SECONDARY_PROMPT_PATTERN
Set the template for prompts for secondary (continuation) lines. This is a prompt template as described in the class header.- See Also:
- Constant Field Values
-
LINE_OFFSET
static final java.lang.String LINE_OFFSET
When in multiline edit mode, this variable can be used to offset the line number displayed.- See Also:
- Constant Field Values
-
AMBIGUOUS_BINDING
static final java.lang.String AMBIGUOUS_BINDING
Timeout for ambiguous key sequences. If the key sequence is ambiguous, i.e. there is a matching sequence but the sequence is also a prefix for other bindings, the next key press will be waited for a specified amount of time. If the timeout elapses, the matched sequence will be used.- See Also:
- Constant Field Values
-
HISTORY_IGNORE
static final java.lang.String HISTORY_IGNORE
Colon separated list of patterns that will not be saved in history.- See Also:
- Constant Field Values
-
HISTORY_FILE
static final java.lang.String HISTORY_FILE
File system history path.- See Also:
- Constant Field Values
-
HISTORY_SIZE
static final java.lang.String HISTORY_SIZE
Number of history items to keep in memory.- See Also:
- Constant Field Values
-
HISTORY_FILE_SIZE
static final java.lang.String HISTORY_FILE_SIZE
Number of history items to keep in the history file.- See Also:
- Constant Field Values
-
INDENTATION
static final java.lang.String INDENTATION
New line automatic indentation after opening/closing bracket.- See Also:
- Constant Field Values
-
FEATURES_MAX_BUFFER_SIZE
static final java.lang.String FEATURES_MAX_BUFFER_SIZE
Max buffer size for advanced features. Once the length of the buffer reaches this threshold, no advanced features will be enabled. This includes the undo buffer, syntax highlighting, parsing, etc....- See Also:
- Constant Field Values
-
SUGGESTIONS_MIN_BUFFER_SIZE
static final java.lang.String SUGGESTIONS_MIN_BUFFER_SIZE
Min buffer size for tab auto-suggestions. For shorter buffer sizes auto-suggestions are not resolved.- See Also:
- Constant Field Values
-
MAX_REPEAT_COUNT
static final java.lang.String MAX_REPEAT_COUNT
Max number of times a command can be repeated.- See Also:
- Constant Field Values
-
TAB_WIDTH
static final java.lang.String TAB_WIDTH
Number of spaces to display a tabulation, the default is 4.- See Also:
- Constant Field Values
-
INPUT_RC_FILE_NAME
static final java.lang.String INPUT_RC_FILE_NAME
Name of inputrc to read at line reader creation time.- See Also:
- Constant Field Values
-
SYSTEM_PROPERTY_PREFIX
static final java.lang.String SYSTEM_PROPERTY_PREFIX
Prefix to automatically delegate variables to system properties- See Also:
- Constant Field Values
-
-
Method Detail
-
readLine
java.lang.String readLine() throws UserInterruptException, EndOfFileException
Read the next line and return the contents of the buffer. Equivalent toreadLine(null, null, null)
.- Returns:
- the line read
- Throws:
UserInterruptException
- if readLine was interrupted (using Ctrl-C for example)EndOfFileException
- if an EOF has been found (using Ctrl-D for example)java.io.IOError
- in case of other i/o errors
-
readLine
java.lang.String readLine(java.lang.Character mask) throws UserInterruptException, EndOfFileException
Read the next line with the specified character mask. If null, then characters will be echoed. If 0, then no characters will be echoed. Equivalent toreadLine(null, mask, null)
- Parameters:
mask
- The mask character,null
or0
.- Returns:
- A line that is read from the terminal, can never be null.
- Throws:
UserInterruptException
- if readLine was interrupted (using Ctrl-C for example)EndOfFileException
- if an EOF has been found (using Ctrl-D for example)java.io.IOError
- in case of other i/o errors
-
readLine
java.lang.String readLine(java.lang.String prompt) throws UserInterruptException, EndOfFileException
Read the next line with the specified prompt. If null, then the default prompt will be used. Equivalent toreadLine(prompt, null, null)
- Parameters:
prompt
- The prompt to issue to the terminal, may be null.- Returns:
- A line that is read from the terminal, can never be null.
- Throws:
UserInterruptException
- if readLine was interrupted (using Ctrl-C for example)EndOfFileException
- if an EOF has been found (using Ctrl-D for example)java.io.IOError
- in case of other i/o errors
-
readLine
java.lang.String readLine(java.lang.String prompt, java.lang.Character mask) throws UserInterruptException, EndOfFileException
Read a line from the inInputStream
, and return the line (without any trailing newlines). Equivalent toreadLine(prompt, mask, null)
- Parameters:
prompt
- The prompt to issue to the terminal, may be null.mask
- The mask character,null
or0
.- Returns:
- A line that is read from the terminal, can never be null.
- Throws:
UserInterruptException
- if readLine was interrupted (using Ctrl-C for example)EndOfFileException
- if an EOF has been found (using Ctrl-D for example)java.io.IOError
- in case of other i/o errors
-
readLine
java.lang.String readLine(java.lang.String prompt, java.lang.Character mask, java.lang.String buffer) throws UserInterruptException, EndOfFileException
Read a line from the inInputStream
, and return the line (without any trailing newlines). Equivalent toreadLine(prompt, null, mask, buffer)
- Parameters:
prompt
- The prompt to issue to the terminal, may be null. This is a template, with optional'%'
escapes, as described in the class header.mask
- The character mask, may be null.buffer
- The default value presented to the user to edit, may be null.- Returns:
- A line that is read from the terminal, can never be null.
- Throws:
UserInterruptException
- if readLine was interrupted (using Ctrl-C for example)EndOfFileException
- if an EOF has been found (using Ctrl-D for example)java.io.IOError
- in case of other i/o errors
-
readLine
java.lang.String readLine(java.lang.String prompt, java.lang.String rightPrompt, java.lang.Character mask, java.lang.String buffer) throws UserInterruptException, EndOfFileException
Read a line from the inInputStream
, and return the line (without any trailing newlines).- Parameters:
prompt
- The prompt to issue to the terminal, may be null. This is a template, with optional'%'
escapes, as described in the class header.rightPrompt
- The right prompt This is a template, with optional'%'
escapes, as described in the class header.mask
- The character mask, may be null.buffer
- The default value presented to the user to edit, may be null.- Returns:
- A line that is read from the terminal, can never be null.
- Throws:
UserInterruptException
- if readLine was interrupted (using Ctrl-C for example)EndOfFileException
- if an EOF has been found (using Ctrl-D for example)java.io.IOError
- in case of other i/o errors
-
readLine
java.lang.String readLine(java.lang.String prompt, java.lang.String rightPrompt, MaskingCallback maskingCallback, java.lang.String buffer) throws UserInterruptException, EndOfFileException
Read a line from the inInputStream
, and return the line (without any trailing newlines).- Parameters:
prompt
- The prompt to issue to the terminal, may be null. This is a template, with optional'%'
escapes, as described in the class header.rightPrompt
- The right prompt This is a template, with optional'%'
escapes, as described in the class header.maskingCallback
- TheMaskingCallback
to use when displaying lines and adding them to the lineHistory
buffer
- The default value presented to the user to edit, may be null.- Returns:
- A line that is read from the terminal, can never be null.
- Throws:
UserInterruptException
- if readLine was interrupted (using Ctrl-C for example)EndOfFileException
- if an EOF has been found (using Ctrl-D for example)java.io.IOError
- in case of other i/o errors
-
printAbove
void printAbove(java.lang.String str)
Prints a line above the prompt and redraw everything. If the LineReader is not actually reading a line, the string will simply be printed to the terminal.- Parameters:
str
- the string to print- See Also:
printAbove(AttributedString)
-
printAbove
void printAbove(AttributedString str)
Prints a string before the prompt and redraw everything. If the LineReader is not actually reading a line, the string will simply be printed to the terminal.- Parameters:
str
- the string to print- See Also:
printAbove(String)
-
isReading
boolean isReading()
Check if a thread is currently in areadLine()
call.- Returns:
true
if there is an ongoingreadLine()
call.
-
variable
LineReader variable(java.lang.String name, java.lang.Object value)
-
option
LineReader option(LineReader.Option option, boolean value)
-
callWidget
void callWidget(java.lang.String name)
-
getVariables
java.util.Map<java.lang.String,java.lang.Object> getVariables()
-
getVariable
java.lang.Object getVariable(java.lang.String name)
-
setVariable
void setVariable(java.lang.String name, java.lang.Object value)
-
isSet
boolean isSet(LineReader.Option option)
-
setOpt
void setOpt(LineReader.Option option)
-
unsetOpt
void unsetOpt(LineReader.Option option)
-
getTerminal
Terminal getTerminal()
-
getWidgets
java.util.Map<java.lang.String,Widget> getWidgets()
-
getBuiltinWidgets
java.util.Map<java.lang.String,Widget> getBuiltinWidgets()
-
getBuffer
Buffer getBuffer()
-
getAppName
java.lang.String getAppName()
-
runMacro
void runMacro(java.lang.String macro)
Push back a key sequence that will be later consumed by the line reader. This method can be used after reading the cursor position usingTerminal.getCursorPosition(IntConsumer)
.- Parameters:
macro
- the key sequence to push back- See Also:
Terminal.getCursorPosition(IntConsumer)
,readMouseEvent()
-
readMouseEvent
MouseEvent readMouseEvent()
Read a mouse event when theInfoCmp.Capability.key_mouse
sequence has just been read on the input stream. Compared toTerminal.readMouseEvent()
, this method takes into account keys that have been pushed back usingrunMacro(String)
.- Returns:
- the mouse event
- See Also:
runMacro(String)
,Terminal.getCursorPosition(IntConsumer)
-
getHistory
History getHistory()
-
getParser
Parser getParser()
-
getHighlighter
Highlighter getHighlighter()
-
getExpander
Expander getExpander()
-
getKeyMap
java.lang.String getKeyMap()
-
setKeyMap
boolean setKeyMap(java.lang.String name)
-
getParsedLine
ParsedLine getParsedLine()
-
getSearchTerm
java.lang.String getSearchTerm()
-
getRegionActive
LineReader.RegionType getRegionActive()
-
getRegionMark
int getRegionMark()
-
addCommandsInBuffer
void addCommandsInBuffer(java.util.Collection<java.lang.String> commands)
-
editAndAddInBuffer
default void editAndAddInBuffer(java.io.File file) throws java.lang.Exception
- Throws:
java.lang.Exception
-
editAndAddInBuffer
void editAndAddInBuffer(java.nio.file.Path file) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getLastBinding
java.lang.String getLastBinding()
-
getTailTip
java.lang.String getTailTip()
-
setTailTip
void setTailTip(java.lang.String tailTip)
-
setAutosuggestion
void setAutosuggestion(LineReader.SuggestionType type)
-
getAutosuggestion
LineReader.SuggestionType getAutosuggestion()
-
zeroOut
void zeroOut()
Clear any internal buffers.
-
-