LineReader (GraalVM SDK Java API Reference)

```
public interface LineReader
```
Read lines from the console, with input editing.
Thread safety
The LineReader implementations are not thread safe, thus you should not attempt to use a single reader in several threads. Any attempt to call one of the readLine call while one is already executing in a different thread will immediately result in an IllegalStateException being thrown. Other calls may lead to unknown behaviors. There is one exception though: users are allowed to call LineReader.printAbove(String) or LineReader.printAbove(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 printf format strings, using the character '%' to indicate special functionality.
The pattern may include ANSI escapes. It may include these template markers:

%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.

%nPc

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.

%Pc

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 and Description

static class LineReader.Option

static class LineReader.RegionType

static class LineReader.SuggestionType

Nested Classes
Modifier and Type	Interface and Description
`static class`	`LineReader.Option`
`static class`	`LineReader.RegionType`
`static class`	`LineReader.SuggestionType`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPT_AND_HOLD`
`static String`	`ACCEPT_AND_INFER_NEXT_HISTORY`
`static String`	`ACCEPT_LINE`
`static String`	`ACCEPT_LINE_AND_DOWN_HISTORY`
`static String`	`AMBIGUOUS_BINDING` Timeout for ambiguous key sequences.
`static String`	`ARGUMENT_BASE`
`static String`	`BACKWARD_CHAR`
`static String`	`BACKWARD_DELETE_CHAR`
`static String`	`BACKWARD_DELETE_WORD`
`static String`	`BACKWARD_KILL_LINE`
`static String`	`BACKWARD_KILL_WORD`
`static String`	`BACKWARD_WORD`
`static String`	`BEEP`
`static String`	`BEGIN_PASTE`
`static String`	`BEGINNING_OF_BUFFER_OR_HISTORY`
`static String`	`BEGINNING_OF_HISTORY`
`static String`	`BEGINNING_OF_LINE`
`static String`	`BEGINNING_OF_LINE_HIST`
`static String`	`BELL_STYLE`
`static String`	`BIND_TTY_SPECIAL_CHARS`
`static String`	`BLINK_MATCHING_PAREN`
`static String`	`CALLBACK_FINISH`
`static String`	`CALLBACK_INIT`
`static String`	`CALLBACK_KEYMAP`
`static String`	`CAPITALIZE_WORD`
`static String`	`CHARACTER_SEARCH`
`static String`	`CHARACTER_SEARCH_BACKWARD`
`static String`	`CLEAR`
`static String`	`CLEAR_SCREEN`
`static String`	`COMMENT_BEGIN`
`static String`	`COMPLETE_PREFIX`
`static String`	`COMPLETE_WORD`
`static String`	`COMPLETION_STYLE_BACKGROUND` Completion style for displaying the list
`static String`	`COMPLETION_STYLE_DESCRIPTION` Completion style for displaying the candidate description
`static String`	`COMPLETION_STYLE_GROUP` Completion style for displaying groups name
`static String`	`COMPLETION_STYLE_LIST_BACKGROUND`
`static String`	`COMPLETION_STYLE_LIST_DESCRIPTION`
`static String`	`COMPLETION_STYLE_LIST_GROUP`
`static String`	`COMPLETION_STYLE_LIST_SELECTION`
`static String`	`COMPLETION_STYLE_LIST_STARTING`
`static String`	`COMPLETION_STYLE_SELECTION` Completion style for displaying the current selected item
`static String`	`COMPLETION_STYLE_STARTING` Completion style for displaying the matching part of candidates
`static String`	`COPY_PREV_WORD`
`static String`	`COPY_REGION_AS_KILL`
`static String`	`DELETE_CHAR`
`static String`	`DELETE_CHAR_OR_LIST`
`static String`	`DELETE_WORD`
`static String`	`DIGIT_ARGUMENT`
`static String`	`DISABLE_COMPLETION`
`static String`	`DISABLE_HISTORY`
`static String`	`DO_LOWERCASE_VERSION`
`static String`	`DOWN_CASE_WORD`
`static String`	`DOWN_HISTORY`
`static String`	`DOWN_LINE`
`static String`	`DOWN_LINE_OR_HISTORY`
`static String`	`DOWN_LINE_OR_SEARCH`
`static String`	`EDIT_AND_EXECUTE_COMMAND`
`static String`	`EDITING_MODE`
`static String`	`EMACS`
`static String`	`EMACS_BACKWARD_WORD`
`static String`	`EMACS_EDITING_MODE`
`static String`	`EMACS_FORWARD_WORD`
`static String`	`END_OF_BUFFER_OR_HISTORY`
`static String`	`END_OF_HISTORY`
`static String`	`END_OF_LINE`
`static String`	`END_OF_LINE_HIST`
`static String`	`ERRORS` Number of matching errors that are accepted by the completion matcher
`static String`	`EXCHANGE_POINT_AND_MARK`
`static String`	`EXECUTE_NAMED_CMD`
`static String`	`EXPAND_HISTORY`
`static String`	`EXPAND_OR_COMPLETE`
`static String`	`EXPAND_OR_COMPLETE_PREFIX`
`static String`	`EXPAND_WORD`
`static String`	`FEATURES_MAX_BUFFER_SIZE` Max buffer size for advanced features.
`static String`	`FOCUS_IN`
`static String`	`FOCUS_OUT`
`static String`	`FORWARD_CHAR`
`static String`	`FORWARD_WORD`
`static String`	`FRESH_LINE`
`static String`	`HISTORY_BEGINNING_SEARCH_BACKWARD`
`static String`	`HISTORY_BEGINNING_SEARCH_FORWARD`
`static String`	`HISTORY_FILE` File system history path.
`static String`	`HISTORY_FILE_SIZE` Number of history items to keep in the history file.
`static String`	`HISTORY_IGNORE` Colon separated list of patterns that will not be saved in history.
`static String`	`HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD`
`static String`	`HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD`
`static String`	`HISTORY_INCREMENTAL_SEARCH_BACKWARD`
`static String`	`HISTORY_INCREMENTAL_SEARCH_FORWARD`
`static String`	`HISTORY_SEARCH_BACKWARD`
`static String`	`HISTORY_SEARCH_FORWARD`
`static String`	`HISTORY_SIZE` Number of history items to keep in memory.
`static String`	`INDENTATION` New line automatic indentation after opening/closing bracket.
`static String`	`INFER_NEXT_HISTORY`
`static String`	`INSERT_CLOSE_CURLY`
`static String`	`INSERT_CLOSE_PAREN`
`static String`	`INSERT_CLOSE_SQUARE`
`static String`	`INSERT_COMMENT`
`static String`	`INSERT_LAST_WORD`
`static String`	`KEYMAP`
`static String`	`KILL_BUFFER`
`static String`	`KILL_LINE`
`static String`	`KILL_REGION`
`static String`	`KILL_WHOLE_LINE`
`static String`	`KILL_WORD`
`static String`	`LINE_OFFSET` When in multiline edit mode, this variable can be used to offset the line number displayed.
`static String`	`LIST_CHOICES`
`static String`	`LIST_EXPAND`
`static String`	`LIST_MAX` tab completion: if candidates are more than list-max a question will be asked before displaying them
`static String`	`MAGIC_SPACE`
`static String`	`MAIN`
`static String`	`MENU`
`static String`	`MENU_COMPLETE`
`static String`	`MENU_EXPAND_OR_COMPLETE`
`static 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
`static String`	`MENU_SELECT`
`static String`	`MOUSE`
`static String`	`NEG_ARGUMENT`
`static String`	`ORIGINAL_GROUP_NAME` Property for the "original" group name
`static String`	`OTHERS_GROUP_NAME` Property for the "others" group name
`static String`	`OVERWRITE_MODE`
`static String`	`PREFER_VISIBLE_BELL`
`static String`	`PROP_SUPPORT_PARSEDLINE` System property that can be set to avoid a warning being logged when using a Parser which does not return `CompletingParsedLine` objects.
`static String`	`PUT_REPLACE_SELECTION`
`static String`	`QUOTED_INSERT`
`static String`	`READ_COMMAND`
`static String`	`RECURSIVE_EDIT`
`static String`	`REDISPLAY`
`static String`	`REDO`
`static String`	`REDRAW_LINE`
`static String`	`REMOVE_SUFFIX_CHARS`
`static String`	`REVERSE_MENU_COMPLETE`
`static String`	`SAFE`
`static String`	`SEARCH_TERMINATORS`
`static String`	`SECONDARY_PROMPT_PATTERN` Set the template for prompts for secondary (continuation) lines.
`static String`	`SELF_INSERT`
`static String`	`SELF_INSERT_UNMETA`
`static String`	`SEND_BREAK`
`static String`	`SET_LOCAL_HISTORY`
`static String`	`SET_MARK_COMMAND`
`static String`	`SPELL_WORD`
`static String`	`SPLIT_UNDO`
`static String`	`SUGGESTIONS_MIN_BUFFER_SIZE` Min buffer size for tab auto-suggestions.
`static String`	`TRANSPOSE_CHARS`
`static String`	`TRANSPOSE_WORDS`
`static String`	`UNDEFINED_KEY`
`static String`	`UNDO`
`static String`	`UNIVERSAL_ARGUMENT`
`static String`	`UP_CASE_WORD`
`static String`	`UP_HISTORY`
`static String`	`UP_LINE`
`static String`	`UP_LINE_OR_HISTORY`
`static String`	`UP_LINE_OR_SEARCH`
`static String`	`VI_ADD_EOL`
`static String`	`VI_ADD_NEXT`
`static String`	`VI_BACKWARD_BLANK_WORD`
`static String`	`VI_BACKWARD_BLANK_WORD_END`
`static String`	`VI_BACKWARD_CHAR`
`static String`	`VI_BACKWARD_DELETE_CHAR`
`static String`	`VI_BACKWARD_KILL_WORD`
`static String`	`VI_BACKWARD_WORD`
`static String`	`VI_BACKWARD_WORD_END`
`static String`	`VI_BEGINNING_OF_LINE`
`static String`	`VI_CHANGE`
`static String`	`VI_CHANGE_EOL`
`static String`	`VI_CHANGE_WHOLE_LINE`
`static String`	`VI_CMD_MODE`
`static String`	`VI_DELETE`
`static String`	`VI_DELETE_CHAR`
`static String`	`VI_DIGIT_OR_BEGINNING_OF_LINE`
`static String`	`VI_DOWN_LINE_OR_HISTORY`
`static String`	`VI_END_OF_LINE`
`static String`	`VI_FETCH_HISTORY`
`static String`	`VI_FIND_NEXT_CHAR`
`static String`	`VI_FIND_NEXT_CHAR_SKIP`
`static String`	`VI_FIND_PREV_CHAR`
`static String`	`VI_FIND_PREV_CHAR_SKIP`
`static String`	`VI_FIRST_NON_BLANK`
`static String`	`VI_FORWARD_BLANK_WORD`
`static String`	`VI_FORWARD_BLANK_WORD_END`
`static String`	`VI_FORWARD_CHAR`
`static String`	`VI_FORWARD_WORD`
`static String`	`VI_FORWARD_WORD_END`
`static String`	`VI_GOTO_COLUMN`
`static String`	`VI_HISTORY_SEARCH_BACKWARD`
`static String`	`VI_HISTORY_SEARCH_FORWARD`
`static String`	`VI_INSERT`
`static String`	`VI_INSERT_BOL`
`static String`	`VI_INSERT_COMMENT`
`static String`	`VI_JOIN`
`static String`	`VI_KILL_EOL`
`static String`	`VI_KILL_LINE`
`static String`	`VI_MATCH_BRACKET`
`static String`	`VI_OPEN_LINE_ABOVE`
`static String`	`VI_OPEN_LINE_BELOW`
`static String`	`VI_OPER_SWAP_CASE`
`static String`	`VI_PUT_AFTER`
`static String`	`VI_PUT_BEFORE`
`static String`	`VI_QUOTED_INSERT`
`static String`	`VI_REPEAT_CHANGE`
`static String`	`VI_REPEAT_FIND`
`static String`	`VI_REPEAT_SEARCH`
`static String`	`VI_REPLACE`
`static String`	`VI_REPLACE_CHARS`
`static String`	`VI_REV_REPEAT_FIND`
`static String`	`VI_REV_REPEAT_SEARCH`
`static String`	`VI_SET_BUFFER`
`static String`	`VI_SUBSTITUTE`
`static String`	`VI_SWAP_CASE`
`static String`	`VI_UNDO_CHANGE`
`static String`	`VI_UP_LINE_OR_HISTORY`
`static String`	`VI_YANK`
`static String`	`VI_YANK_EOL`
`static String`	`VI_YANK_WHOLE_LINE`
`static String`	`VICMD`
`static String`	`VIINS`
`static String`	`VIOPP`
`static String`	`VISUAL`
`static String`	`VISUAL_LINE_MODE`
`static String`	`VISUAL_MODE`
`static String`	`WHAT_CURSOR_POSITION`
`static String`	`WORDCHARS`
`static String`	`YANK`
`static String`	`YANK_POP`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCommandsInBuffer(Collection<String> commands)`
`void`	`callWidget(String name)`
`Map<String,org.graalvm.shadowed.org.jline.keymap.KeyMap<Binding>>`	`defaultKeyMaps()`
`void`	`editAndAddInBuffer(File file)`
`String`	`getAppName()`
`LineReader.SuggestionType`	`getAutosuggestion()`
`Buffer`	`getBuffer()`
`Map<String,Widget>`	`getBuiltinWidgets()`
`Expander`	`getExpander()`
`Highlighter`	`getHighlighter()`
`History`	`getHistory()`
`String`	`getKeyMap()`
`Map<String,org.graalvm.shadowed.org.jline.keymap.KeyMap<Binding>>`	`getKeyMaps()`
`org.graalvm.shadowed.org.jline.keymap.KeyMap<Binding>`	`getKeys()`
`String`	`getLastBinding()`
`ParsedLine`	`getParsedLine()`
`Parser`	`getParser()`
`LineReader.RegionType`	`getRegionActive()`
`int`	`getRegionMark()`
`String`	`getSearchTerm()`
`String`	`getTailTip()`
`org.graalvm.shadowed.org.jline.terminal.Terminal`	`getTerminal()`
`Object`	`getVariable(String name)`
`Map<String,Object>`	`getVariables()`
`Map<String,Widget>`	`getWidgets()`
`boolean`	`isReading()` Check if a thread is currently in a `readLine()` call.
`boolean`	`isSet(LineReader.Option option)`
`LineReader`	`option(LineReader.Option option, boolean value)`
`void`	`printAbove(AttributedString str)` Prints a string before the prompt and redraw everything.
`void`	`printAbove(String str)` Prints a line above the prompt and redraw everything.
`String`	`readLine()` Read the next line and return the contents of the buffer.
`String`	`readLine(Character mask)` Read the next line with the specified character mask.
`String`	`readLine(String prompt)` Read the next line with the specified prompt.
`String`	`readLine(String prompt, Character mask)` Read a line from the in `InputStream`, and return the line (without any trailing newlines).
`String`	`readLine(String prompt, Character mask, String buffer)` Read a line from the in `InputStream`, and return the line (without any trailing newlines).
`String`	`readLine(String prompt, String rightPrompt, Character mask, String buffer)` Read a line from the in `InputStream`, and return the line (without any trailing newlines).
`String`	`readLine(String prompt, String rightPrompt, MaskingCallback maskingCallback, String buffer)` Read a line from the in `InputStream`, and return the line (without any trailing newlines).
`org.graalvm.shadowed.org.jline.terminal.MouseEvent`	`readMouseEvent()` Read a mouse event when the `InfoCmp.Capability.key_mouse` sequence has just been read on the input stream.
`void`	`runMacro(String macro)` Push back a key sequence that will be later consumed by the line reader.
`void`	`setAutosuggestion(LineReader.SuggestionType type)`
`boolean`	`setKeyMap(String name)`
`void`	`setOpt(LineReader.Option option)`
`void`	`setTailTip(String tailTip)`
`void`	`setVariable(String name, Object value)`
`void`	`unsetOpt(LineReader.Option option)`
`LineReader`	`variable(String name, Object value)`

- Field Detail
  - PROP_SUPPORT_PARSEDLINE
```
static final String PROP_SUPPORT_PARSEDLINE
```
    System property that can be set to avoid a warning being logged when using a Parser which does not return CompletingParsedLine objects.
    
    See Also:
    
    Constant Field Values
  - CALLBACK_INIT
```
static final String CALLBACK_INIT
```
    See Also:
    
    Constant Field Values
  - CALLBACK_FINISH
```
static final String CALLBACK_FINISH
```
    See Also:
    
    Constant Field Values
  - CALLBACK_KEYMAP
```
static final String CALLBACK_KEYMAP
```
    See Also:
    
    Constant Field Values
  - ACCEPT_AND_INFER_NEXT_HISTORY
```
static final String ACCEPT_AND_INFER_NEXT_HISTORY
```
    See Also:
    
    Constant Field Values
  - ACCEPT_AND_HOLD
```
static final String ACCEPT_AND_HOLD
```
    See Also:
    
    Constant Field Values
  - ACCEPT_LINE
```
static final String ACCEPT_LINE
```
    See Also:
    
    Constant Field Values
  - ACCEPT_LINE_AND_DOWN_HISTORY
```
static final String ACCEPT_LINE_AND_DOWN_HISTORY
```
    See Also:
    
    Constant Field Values
  - ARGUMENT_BASE
```
static final String ARGUMENT_BASE
```
    See Also:
    
    Constant Field Values
  - BACKWARD_CHAR
```
static final String BACKWARD_CHAR
```
    See Also:
    
    Constant Field Values
  - BACKWARD_DELETE_CHAR
```
static final String BACKWARD_DELETE_CHAR
```
    See Also:
    
    Constant Field Values
  - BACKWARD_DELETE_WORD
```
static final String BACKWARD_DELETE_WORD
```
    See Also:
    
    Constant Field Values
  - BACKWARD_KILL_LINE
```
static final String BACKWARD_KILL_LINE
```
    See Also:
    
    Constant Field Values
  - BACKWARD_KILL_WORD
```
static final String BACKWARD_KILL_WORD
```
    See Also:
    
    Constant Field Values
  - BACKWARD_WORD
```
static final String BACKWARD_WORD
```
    See Also:
    
    Constant Field Values
  - BEEP
```
static final String BEEP
```
    See Also:
    
    Constant Field Values
  - BEGINNING_OF_BUFFER_OR_HISTORY
```
static final String BEGINNING_OF_BUFFER_OR_HISTORY
```
    See Also:
    
    Constant Field Values
  - BEGINNING_OF_HISTORY
```
static final String BEGINNING_OF_HISTORY
```
    See Also:
    
    Constant Field Values
  - BEGINNING_OF_LINE
```
static final String BEGINNING_OF_LINE
```
    See Also:
    
    Constant Field Values
  - BEGINNING_OF_LINE_HIST
```
static final String BEGINNING_OF_LINE_HIST
```
    See Also:
    
    Constant Field Values
  - CAPITALIZE_WORD
```
static final String CAPITALIZE_WORD
```
    See Also:
    
    Constant Field Values
  - CHARACTER_SEARCH
```
static final String CHARACTER_SEARCH
```
    See Also:
    
    Constant Field Values
  - CHARACTER_SEARCH_BACKWARD
```
static final String CHARACTER_SEARCH_BACKWARD
```
    See Also:
    
    Constant Field Values
  - CLEAR
```
static final String CLEAR
```
    See Also:
    
    Constant Field Values
  - CLEAR_SCREEN
```
static final String CLEAR_SCREEN
```
    See Also:
    
    Constant Field Values
  - COMPLETE_PREFIX
```
static final String COMPLETE_PREFIX
```
    See Also:
    
    Constant Field Values
  - COMPLETE_WORD
```
static final String COMPLETE_WORD
```
    See Also:
    
    Constant Field Values
  - COPY_PREV_WORD
```
static final String COPY_PREV_WORD
```
    See Also:
    
    Constant Field Values
  - COPY_REGION_AS_KILL
```
static final String COPY_REGION_AS_KILL
```
    See Also:
    
    Constant Field Values
  - DELETE_CHAR
```
static final String DELETE_CHAR
```
    See Also:
    
    Constant Field Values
  - DELETE_CHAR_OR_LIST
```
static final String DELETE_CHAR_OR_LIST
```
    See Also:
    
    Constant Field Values
  - DELETE_WORD
```
static final String DELETE_WORD
```
    See Also:
    
    Constant Field Values
  - DIGIT_ARGUMENT
```
static final String DIGIT_ARGUMENT
```
    See Also:
    
    Constant Field Values
  - DO_LOWERCASE_VERSION
```
static final String DO_LOWERCASE_VERSION
```
    See Also:
    
    Constant Field Values
  - DOWN_CASE_WORD
```
static final String DOWN_CASE_WORD
```
    See Also:
    
    Constant Field Values
  - DOWN_HISTORY
```
static final String DOWN_HISTORY
```
    See Also:
    
    Constant Field Values
  - DOWN_LINE
```
static final String DOWN_LINE
```
    See Also:
    
    Constant Field Values
  - DOWN_LINE_OR_HISTORY
```
static final String DOWN_LINE_OR_HISTORY
```
    See Also:
    
    Constant Field Values
  - DOWN_LINE_OR_SEARCH
```
static final String DOWN_LINE_OR_SEARCH
```
    See Also:
    
    Constant Field Values
  - EDIT_AND_EXECUTE_COMMAND
```
static final String EDIT_AND_EXECUTE_COMMAND
```
    See Also:
    
    Constant Field Values
  - EMACS_BACKWARD_WORD
```
static final String EMACS_BACKWARD_WORD
```
    See Also:
    
    Constant Field Values
  - EMACS_EDITING_MODE
```
static final String EMACS_EDITING_MODE
```
    See Also:
    
    Constant Field Values
  - EMACS_FORWARD_WORD
```
static final String EMACS_FORWARD_WORD
```
    See Also:
    
    Constant Field Values
  - END_OF_BUFFER_OR_HISTORY
```
static final String END_OF_BUFFER_OR_HISTORY
```
    See Also:
    
    Constant Field Values
  - END_OF_HISTORY
```
static final String END_OF_HISTORY
```
    See Also:
    
    Constant Field Values
  - END_OF_LINE
```
static final String END_OF_LINE
```
    See Also:
    
    Constant Field Values
  - END_OF_LINE_HIST
```
static final String END_OF_LINE_HIST
```
    See Also:
    
    Constant Field Values
  - EXCHANGE_POINT_AND_MARK
```
static final String EXCHANGE_POINT_AND_MARK
```
    See Also:
    
    Constant Field Values
  - EXECUTE_NAMED_CMD
```
static final String EXECUTE_NAMED_CMD
```
    See Also:
    
    Constant Field Values
  - EXPAND_HISTORY
```
static final String EXPAND_HISTORY
```
    See Also:
    
    Constant Field Values
  - EXPAND_OR_COMPLETE
```
static final String EXPAND_OR_COMPLETE
```
    See Also:
    
    Constant Field Values
  - EXPAND_OR_COMPLETE_PREFIX
```
static final String EXPAND_OR_COMPLETE_PREFIX
```
    See Also:
    
    Constant Field Values
  - EXPAND_WORD
```
static final String EXPAND_WORD
```
    See Also:
    
    Constant Field Values
  - FRESH_LINE
```
static final String FRESH_LINE
```
    See Also:
    
    Constant Field Values
  - FORWARD_CHAR
```
static final String FORWARD_CHAR
```
    See Also:
    
    Constant Field Values
  - FORWARD_WORD
```
static final String FORWARD_WORD
```
    See Also:
    
    Constant Field Values
  - HISTORY_BEGINNING_SEARCH_BACKWARD
```
static final String HISTORY_BEGINNING_SEARCH_BACKWARD
```
    See Also:
    
    Constant Field Values
  - HISTORY_BEGINNING_SEARCH_FORWARD
```
static final String HISTORY_BEGINNING_SEARCH_FORWARD
```
    See Also:
    
    Constant Field Values
  - HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD
```
static final String HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD
```
    See Also:
    
    Constant Field Values
  - HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD
```
static final String HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD
```
    See Also:
    
    Constant Field Values
  - HISTORY_INCREMENTAL_SEARCH_BACKWARD
```
static final String HISTORY_INCREMENTAL_SEARCH_BACKWARD
```
    See Also:
    
    Constant Field Values
  - HISTORY_INCREMENTAL_SEARCH_FORWARD
```
static final String HISTORY_INCREMENTAL_SEARCH_FORWARD
```
    See Also:
    
    Constant Field Values
  - HISTORY_SEARCH_BACKWARD
```
static final String HISTORY_SEARCH_BACKWARD
```
    See Also:
    
    Constant Field Values
  - HISTORY_SEARCH_FORWARD
```
static final String HISTORY_SEARCH_FORWARD
```
    See Also:
    
    Constant Field Values
  - INSERT_CLOSE_CURLY
```
static final String INSERT_CLOSE_CURLY
```
    See Also:
    
    Constant Field Values
  - INSERT_CLOSE_PAREN
```
static final String INSERT_CLOSE_PAREN
```
    See Also:
    
    Constant Field Values
  - INSERT_CLOSE_SQUARE
```
static final String INSERT_CLOSE_SQUARE
```
    See Also:
    
    Constant Field Values
  - INFER_NEXT_HISTORY
```
static final String INFER_NEXT_HISTORY
```
    See Also:
    
    Constant Field Values
  - INSERT_COMMENT
```
static final String INSERT_COMMENT
```
    See Also:
    
    Constant Field Values
  - INSERT_LAST_WORD
```
static final String INSERT_LAST_WORD
```
    See Also:
    
    Constant Field Values
  - KILL_BUFFER
```
static final String KILL_BUFFER
```
    See Also:
    
    Constant Field Values
  - KILL_LINE
```
static final String KILL_LINE
```
    See Also:
    
    Constant Field Values
  - KILL_REGION
```
static final String KILL_REGION
```
    See Also:
    
    Constant Field Values
  - KILL_WHOLE_LINE
```
static final String KILL_WHOLE_LINE
```
    See Also:
    
    Constant Field Values
  - KILL_WORD
```
static final String KILL_WORD
```
    See Also:
    
    Constant Field Values
  - LIST_CHOICES
```
static final String LIST_CHOICES
```
    See Also:
    
    Constant Field Values
  - LIST_EXPAND
```
static final String LIST_EXPAND
```
    See Also:
    
    Constant Field Values
  - MAGIC_SPACE
```
static final String MAGIC_SPACE
```
    See Also:
    
    Constant Field Values
  - MENU_EXPAND_OR_COMPLETE
```
static final String MENU_EXPAND_OR_COMPLETE
```
    See Also:
    
    Constant Field Values
  - MENU_COMPLETE
```
static final String MENU_COMPLETE
```
    See Also:
    
    Constant Field Values
  - MENU_SELECT
```
static final String MENU_SELECT
```
    See Also:
    
    Constant Field Values
  - NEG_ARGUMENT
```
static final String NEG_ARGUMENT
```
    See Also:
    
    Constant Field Values
  - OVERWRITE_MODE
```
static final String OVERWRITE_MODE
```
    See Also:
    
    Constant Field Values
  - PUT_REPLACE_SELECTION
```
static final String PUT_REPLACE_SELECTION
```
    See Also:
    
    Constant Field Values
  - QUOTED_INSERT
```
static final String QUOTED_INSERT
```
    See Also:
    
    Constant Field Values
  - READ_COMMAND
```
static final String READ_COMMAND
```
    See Also:
    
    Constant Field Values
  - RECURSIVE_EDIT
```
static final String RECURSIVE_EDIT
```
    See Also:
    
    Constant Field Values
  - REDISPLAY
```
static final String REDISPLAY
```
    See Also:
    
    Constant Field Values
  - REDRAW_LINE
```
static final String REDRAW_LINE
```
    See Also:
    
    Constant Field Values
  - REDO
```
static final String REDO
```
    See Also:
    
    Constant Field Values
  - REVERSE_MENU_COMPLETE
```
static final String REVERSE_MENU_COMPLETE
```
    See Also:
    
    Constant Field Values
  - SELF_INSERT
```
static final String SELF_INSERT
```
    See Also:
    
    Constant Field Values
  - SELF_INSERT_UNMETA
```
static final String SELF_INSERT_UNMETA
```
    See Also:
    
    Constant Field Values
  - SEND_BREAK
```
static final String SEND_BREAK
```
    See Also:
    
    Constant Field Values
  - SET_LOCAL_HISTORY
```
static final String SET_LOCAL_HISTORY
```
    See Also:
    
    Constant Field Values
  - SET_MARK_COMMAND
```
static final String SET_MARK_COMMAND
```
    See Also:
    
    Constant Field Values
  - SPELL_WORD
```
static final String SPELL_WORD
```
    See Also:
    
    Constant Field Values
  - SPLIT_UNDO
```
static final String SPLIT_UNDO
```
    See Also:
    
    Constant Field Values
  - TRANSPOSE_CHARS
```
static final String TRANSPOSE_CHARS
```
    See Also:
    
    Constant Field Values
  - TRANSPOSE_WORDS
```
static final String TRANSPOSE_WORDS
```
    See Also:
    
    Constant Field Values
  - UNDEFINED_KEY
```
static final String UNDEFINED_KEY
```
    See Also:
    
    Constant Field Values
  - UNDO
```
static final String UNDO
```
    See Also:
    
    Constant Field Values
  - UNIVERSAL_ARGUMENT
```
static final String UNIVERSAL_ARGUMENT
```
    See Also:
    
    Constant Field Values
  - UP_CASE_WORD
```
static final String UP_CASE_WORD
```
    See Also:
    
    Constant Field Values
  - UP_HISTORY
```
static final String UP_HISTORY
```
    See Also:
    
    Constant Field Values
  - UP_LINE
```
static final String UP_LINE
```
    See Also:
    
    Constant Field Values
  - UP_LINE_OR_HISTORY
```
static final String UP_LINE_OR_HISTORY
```
    See Also:
    
    Constant Field Values
  - UP_LINE_OR_SEARCH
```
static final String UP_LINE_OR_SEARCH
```
    See Also:
    
    Constant Field Values
  - VI_ADD_EOL
```
static final String VI_ADD_EOL
```
    See Also:
    
    Constant Field Values
  - VI_ADD_NEXT
```
static final String VI_ADD_NEXT
```
    See Also:
    
    Constant Field Values
  - VI_BACKWARD_BLANK_WORD
```
static final String VI_BACKWARD_BLANK_WORD
```
    See Also:
    
    Constant Field Values
  - VI_BACKWARD_BLANK_WORD_END
```
static final String VI_BACKWARD_BLANK_WORD_END
```
    See Also:
    
    Constant Field Values
  - VI_BACKWARD_CHAR
```
static final String VI_BACKWARD_CHAR
```
    See Also:
    
    Constant Field Values
  - VI_BACKWARD_DELETE_CHAR
```
static final String VI_BACKWARD_DELETE_CHAR
```
    See Also:
    
    Constant Field Values
  - VI_BACKWARD_KILL_WORD
```
static final String VI_BACKWARD_KILL_WORD
```
    See Also:
    
    Constant Field Values
  - VI_BACKWARD_WORD
```
static final String VI_BACKWARD_WORD
```
    See Also:
    
    Constant Field Values
  - VI_BACKWARD_WORD_END
```
static final String VI_BACKWARD_WORD_END
```
    See Also:
    
    Constant Field Values
  - VI_BEGINNING_OF_LINE
```
static final String VI_BEGINNING_OF_LINE
```
    See Also:
    
    Constant Field Values
  - VI_CHANGE
```
static final String VI_CHANGE
```
    See Also:
    
    Constant Field Values
  - VI_CHANGE_EOL
```
static final String VI_CHANGE_EOL
```
    See Also:
    
    Constant Field Values
  - VI_CHANGE_WHOLE_LINE
```
static final String VI_CHANGE_WHOLE_LINE
```
    See Also:
    
    Constant Field Values
  - VI_CMD_MODE
```
static final String VI_CMD_MODE
```
    See Also:
    
    Constant Field Values
  - VI_DELETE
```
static final String VI_DELETE
```
    See Also:
    
    Constant Field Values
  - VI_DELETE_CHAR
```
static final String VI_DELETE_CHAR
```
    See Also:
    
    Constant Field Values
  - VI_DIGIT_OR_BEGINNING_OF_LINE
```
static final String VI_DIGIT_OR_BEGINNING_OF_LINE
```
    See Also:
    
    Constant Field Values
  - VI_DOWN_LINE_OR_HISTORY
```
static final String VI_DOWN_LINE_OR_HISTORY
```
    See Also:
    
    Constant Field Values
  - VI_END_OF_LINE
```
static final String VI_END_OF_LINE
```
    See Also:
    
    Constant Field Values
  - VI_FETCH_HISTORY
```
static final String VI_FETCH_HISTORY
```
    See Also:
    
    Constant Field Values
  - VI_FIND_NEXT_CHAR
```
static final String VI_FIND_NEXT_CHAR
```
    See Also:
    
    Constant Field Values
  - VI_FIND_NEXT_CHAR_SKIP
```
static final String VI_FIND_NEXT_CHAR_SKIP
```
    See Also:
    
    Constant Field Values
  - VI_FIND_PREV_CHAR
```
static final String VI_FIND_PREV_CHAR
```
    See Also:
    
    Constant Field Values
  - VI_FIND_PREV_CHAR_SKIP
```
static final String VI_FIND_PREV_CHAR_SKIP
```
    See Also:
    
    Constant Field Values
  - VI_FIRST_NON_BLANK
```
static final String VI_FIRST_NON_BLANK
```
    See Also:
    
    Constant Field Values
  - VI_FORWARD_BLANK_WORD
```
static final String VI_FORWARD_BLANK_WORD
```
    See Also:
    
    Constant Field Values
  - VI_FORWARD_BLANK_WORD_END
```
static final String VI_FORWARD_BLANK_WORD_END
```
    See Also:
    
    Constant Field Values
  - VI_FORWARD_CHAR
```
static final String VI_FORWARD_CHAR
```
    See Also:
    
    Constant Field Values
  - VI_FORWARD_WORD
```
static final String VI_FORWARD_WORD
```
    See Also:
    
    Constant Field Values
  - VI_FORWARD_WORD_END
```
static final String VI_FORWARD_WORD_END
```
    See Also:
    
    Constant Field Values
  - VI_GOTO_COLUMN
```
static final String VI_GOTO_COLUMN
```
    See Also:
    
    Constant Field Values
  - VI_HISTORY_SEARCH_BACKWARD
```
static final String VI_HISTORY_SEARCH_BACKWARD
```
    See Also:
    
    Constant Field Values
  - VI_HISTORY_SEARCH_FORWARD
```
static final String VI_HISTORY_SEARCH_FORWARD
```
    See Also:
    
    Constant Field Values
  - VI_INSERT
```
static final String VI_INSERT
```
    See Also:
    
    Constant Field Values
  - VI_INSERT_BOL
```
static final String VI_INSERT_BOL
```
    See Also:
    
    Constant Field Values
  - VI_INSERT_COMMENT
```
static final String VI_INSERT_COMMENT
```
    See Also:
    
    Constant Field Values
  - VI_JOIN
```
static final String VI_JOIN
```
    See Also:
    
    Constant Field Values
  - VI_KILL_EOL
```
static final String VI_KILL_EOL
```
    See Also:
    
    Constant Field Values
  - VI_KILL_LINE
```
static final String VI_KILL_LINE
```
    See Also:
    
    Constant Field Values
  - VI_MATCH_BRACKET
```
static final String VI_MATCH_BRACKET
```
    See Also:
    
    Constant Field Values
  - VI_OPEN_LINE_ABOVE
```
static final String VI_OPEN_LINE_ABOVE
```
    See Also:
    
    Constant Field Values
  - VI_OPEN_LINE_BELOW
```
static final String VI_OPEN_LINE_BELOW
```
    See Also:
    
    Constant Field Values
  - VI_OPER_SWAP_CASE
```
static final String VI_OPER_SWAP_CASE
```
    See Also:
    
    Constant Field Values
  - VI_PUT_AFTER
```
static final String VI_PUT_AFTER
```
    See Also:
    
    Constant Field Values
  - VI_PUT_BEFORE
```
static final String VI_PUT_BEFORE
```
    See Also:
    
    Constant Field Values
  - VI_QUOTED_INSERT
```
static final String VI_QUOTED_INSERT
```
    See Also:
    
    Constant Field Values
  - VI_REPEAT_CHANGE
```
static final String VI_REPEAT_CHANGE
```
    See Also:
    
    Constant Field Values
  - VI_REPEAT_FIND
```
static final String VI_REPEAT_FIND
```
    See Also:
    
    Constant Field Values
  - VI_REPEAT_SEARCH
```
static final String VI_REPEAT_SEARCH
```
    See Also:
    
    Constant Field Values
  - VI_REPLACE
```
static final String VI_REPLACE
```
    See Also:
    
    Constant Field Values
  - VI_REPLACE_CHARS
```
static final String VI_REPLACE_CHARS
```
    See Also:
    
    Constant Field Values
  - VI_REV_REPEAT_FIND
```
static final String VI_REV_REPEAT_FIND
```
    See Also:
    
    Constant Field Values
  - VI_REV_REPEAT_SEARCH
```
static final String VI_REV_REPEAT_SEARCH
```
    See Also:
    
    Constant Field Values
  - VI_SET_BUFFER
```
static final String VI_SET_BUFFER
```
    See Also:
    
    Constant Field Values
  - VI_SUBSTITUTE
```
static final String VI_SUBSTITUTE
```
    See Also:
    
    Constant Field Values
  - VI_SWAP_CASE
```
static final String VI_SWAP_CASE
```
    See Also:
    
    Constant Field Values
  - VI_UNDO_CHANGE
```
static final String VI_UNDO_CHANGE
```
    See Also:
    
    Constant Field Values
  - VI_UP_LINE_OR_HISTORY
```
static final String VI_UP_LINE_OR_HISTORY
```
    See Also:
    
    Constant Field Values
  - VI_YANK
```
static final String VI_YANK
```
    See Also:
    
    Constant Field Values
  - VI_YANK_EOL
```
static final String VI_YANK_EOL
```
    See Also:
    
    Constant Field Values
  - VI_YANK_WHOLE_LINE
```
static final String VI_YANK_WHOLE_LINE
```
    See Also:
    
    Constant Field Values
  - VISUAL_LINE_MODE
```
static final String VISUAL_LINE_MODE
```
    See Also:
    
    Constant Field Values
  - VISUAL_MODE
```
static final String VISUAL_MODE
```
    See Also:
    
    Constant Field Values
  - WHAT_CURSOR_POSITION
```
static final String WHAT_CURSOR_POSITION
```
    See Also:
    
    Constant Field Values
  - YANK
```
static final String YANK
```
    See Also:
    
    Constant Field Values
  - YANK_POP
```
static final String YANK_POP
```
    See Also:
    
    Constant Field Values
  - MOUSE
```
static final String MOUSE
```
    See Also:
    
    Constant Field Values
  - FOCUS_IN
```
static final String FOCUS_IN
```
    See Also:
    
    Constant Field Values
  - FOCUS_OUT
```
static final String FOCUS_OUT
```
    See Also:
    
    Constant Field Values
  - BEGIN_PASTE
```
static final String BEGIN_PASTE
```
    See Also:
    
    Constant Field Values
  - VICMD
```
static final String VICMD
```
    See Also:
    
    Constant Field Values
  - VIINS
```
static final String VIINS
```
    See Also:
    
    Constant Field Values
  - VIOPP
```
static final String VIOPP
```
    See Also:
    
    Constant Field Values
  - VISUAL
```
static final String VISUAL
```
    See Also:
    
    Constant Field Values
  - MAIN
```
static final String MAIN
```
    See Also:
    
    Constant Field Values
  - EMACS
```
static final String EMACS
```
    See Also:
    
    Constant Field Values
  - SAFE
```
static final String SAFE
```
    See Also:
    
    Constant Field Values
  - MENU
```
static final String MENU
```
    See Also:
    
    Constant Field Values
  - BIND_TTY_SPECIAL_CHARS
```
static final String BIND_TTY_SPECIAL_CHARS
```
    See Also:
    
    Constant Field Values
  - COMMENT_BEGIN
```
static final String COMMENT_BEGIN
```
    See Also:
    
    Constant Field Values
  - BELL_STYLE
```
static final String BELL_STYLE
```
    See Also:
    
    Constant Field Values
  - PREFER_VISIBLE_BELL
```
static final String PREFER_VISIBLE_BELL
```
    See Also:
    
    Constant Field Values
  - LIST_MAX
```
static final 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 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 String DISABLE_HISTORY
```
    See Also:
    
    Constant Field Values
  - DISABLE_COMPLETION
```
static final String DISABLE_COMPLETION
```
    See Also:
    
    Constant Field Values
  - EDITING_MODE
```
static final String EDITING_MODE
```
    See Also:
    
    Constant Field Values
  - KEYMAP
```
static final String KEYMAP
```
    See Also:
    
    Constant Field Values
  - BLINK_MATCHING_PAREN
```
static final String BLINK_MATCHING_PAREN
```
    See Also:
    
    Constant Field Values
  - WORDCHARS
```
static final String WORDCHARS
```
    See Also:
    
    Constant Field Values
  - REMOVE_SUFFIX_CHARS
```
static final String REMOVE_SUFFIX_CHARS
```
    See Also:
    
    Constant Field Values
  - SEARCH_TERMINATORS
```
static final String SEARCH_TERMINATORS
```
    See Also:
    
    Constant Field Values
  - ERRORS
```
static final String ERRORS
```
    Number of matching errors that are accepted by the completion matcher
    
    See Also:
    
    Constant Field Values
  - OTHERS_GROUP_NAME
```
static final String OTHERS_GROUP_NAME
```
    Property for the "others" group name
    
    See Also:
    
    Constant Field Values
  - ORIGINAL_GROUP_NAME
```
static final String ORIGINAL_GROUP_NAME
```
    Property for the "original" group name
    
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_GROUP
```
static final String COMPLETION_STYLE_GROUP
```
    Completion style for displaying groups name
    
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_LIST_GROUP
```
static final String COMPLETION_STYLE_LIST_GROUP
```
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_SELECTION
```
static final String COMPLETION_STYLE_SELECTION
```
    Completion style for displaying the current selected item
    
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_LIST_SELECTION
```
static final String COMPLETION_STYLE_LIST_SELECTION
```
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_DESCRIPTION
```
static final String COMPLETION_STYLE_DESCRIPTION
```
    Completion style for displaying the candidate description
    
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_LIST_DESCRIPTION
```
static final String COMPLETION_STYLE_LIST_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_STARTING
```
static final String COMPLETION_STYLE_STARTING
```
    Completion style for displaying the matching part of candidates
    
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_LIST_STARTING
```
static final String COMPLETION_STYLE_LIST_STARTING
```
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_BACKGROUND
```
static final String COMPLETION_STYLE_BACKGROUND
```
    Completion style for displaying the list
    
    See Also:
    
    Constant Field Values
  - COMPLETION_STYLE_LIST_BACKGROUND
```
static final String COMPLETION_STYLE_LIST_BACKGROUND
```
    See Also:
    
    Constant Field Values
  - SECONDARY_PROMPT_PATTERN
```
static final 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 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 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 String HISTORY_IGNORE
```
    Colon separated list of patterns that will not be saved in history.
    
    See Also:
    
    Constant Field Values
  - HISTORY_FILE
```
static final String HISTORY_FILE
```
    File system history path.
    
    See Also:
    
    Constant Field Values
  - HISTORY_SIZE
```
static final String HISTORY_SIZE
```
    Number of history items to keep in memory.
    
    See Also:
    
    Constant Field Values
  - HISTORY_FILE_SIZE
```
static final String HISTORY_FILE_SIZE
```
    Number of history items to keep in the history file.
    
    See Also:
    
    Constant Field Values
  - INDENTATION
```
static final String INDENTATION
```
    New line automatic indentation after opening/closing bracket.
    
    See Also:
    
    Constant Field Values
  - FEATURES_MAX_BUFFER_SIZE
```
static final 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 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
- Method Detail
  - defaultKeyMaps
```
Map<String,org.graalvm.shadowed.org.jline.keymap.KeyMap<Binding>> defaultKeyMaps()
```
  - readLine
```
String readLine()
         throws UserInterruptException,
                EndOfFileException
```
    Read the next line and return the contents of the buffer. Equivalent to readLine(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)
    
    IOError - in case of other i/o errors
  - readLine
```
String readLine(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 to readLine(null, mask, null)
    
    Parameters:
    
    mask - The mask character, null or 0.
    
    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)
    
    IOError - in case of other i/o errors
  - readLine
```
String readLine(String prompt)
         throws UserInterruptException,
                EndOfFileException
```
    Read the next line with the specified prompt. If null, then the default prompt will be used. Equivalent to readLine(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)
    
    IOError - in case of other i/o errors
  - readLine
```
String readLine(String prompt,
                Character mask)
         throws UserInterruptException,
                EndOfFileException
```
    Read a line from the in InputStream, and return the line (without any trailing newlines). Equivalent to readLine(prompt, mask, null)
    
    Parameters:
    
    prompt - The prompt to issue to the terminal, may be null.
    
    mask - The mask character, null or 0.
    
    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)
    
    IOError - in case of other i/o errors
  - readLine
```
String readLine(String prompt,
                Character mask,
                String buffer)
         throws UserInterruptException,
                EndOfFileException
```
    Read a line from the in InputStream, and return the line (without any trailing newlines). Equivalent to readLine(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)
    
    IOError - in case of other i/o errors
  - readLine
```
String readLine(String prompt,
                String rightPrompt,
                Character mask,
                String buffer)
         throws UserInterruptException,
                EndOfFileException
```
    Read a line from the in InputStream, 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)
    
    IOError - in case of other i/o errors
  - readLine
```
String readLine(String prompt,
                String rightPrompt,
                MaskingCallback maskingCallback,
                String buffer)
         throws UserInterruptException,
                EndOfFileException
```
    Read a line from the in InputStream, 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 - The MaskingCallback to use when displaying lines and adding them to the line History
    
    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)
    
    IOError - in case of other i/o errors
  - printAbove
```
void printAbove(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:
    
    LineReader.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:
    
    LineReader.printAbove(String)
  - isReading
```
boolean isReading()
```
    Check if a thread is currently in a readLine() call.
    
    Returns:
    
    true if there is an ongoing readLine() call.
  - variable
```
LineReader variable(String name,
                    Object value)
```
  - option
```
LineReader option(LineReader.Option option,
                  boolean value)
```
  - callWidget
```
void callWidget(String name)
```
  - getVariables
```
Map<String,Object> getVariables()
```
  - getVariable
```
Object getVariable(String name)
```
  - setVariable
```
void setVariable(String name,
                 Object value)
```
  - isSet
```
boolean isSet(LineReader.Option option)
```
  - setOpt
```
void setOpt(LineReader.Option option)
```
  - unsetOpt
```
void unsetOpt(LineReader.Option option)
```
  - getTerminal
```
org.graalvm.shadowed.org.jline.terminal.Terminal getTerminal()
```
  - getWidgets
```
Map<String,Widget> getWidgets()
```
  - getBuiltinWidgets
```
Map<String,Widget> getBuiltinWidgets()
```
  - getBuffer
```
Buffer getBuffer()
```
  - getAppName
```
String getAppName()
```
  - runMacro
```
void runMacro(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 using Terminal.getCursorPosition(IntConsumer).
    
    Parameters:
    
    macro - the key sequence to push back
    
    See Also:
    
    Terminal.getCursorPosition(IntConsumer), LineReader.readMouseEvent()
  - readMouseEvent
```
org.graalvm.shadowed.org.jline.terminal.MouseEvent readMouseEvent()
```
    Read a mouse event when the InfoCmp.Capability.key_mouse sequence has just been read on the input stream. Compared to Terminal.readMouseEvent(), this method takes into account keys that have been pushed back using LineReader.runMacro(String).
    
    Returns:
    
    the mouse event
    
    See Also:
    
    LineReader.runMacro(String), Terminal.getCursorPosition(IntConsumer)
  - getHistory
```
History getHistory()
```
  - getParser
```
Parser getParser()
```
  - getHighlighter
```
Highlighter getHighlighter()
```
  - getExpander
```
Expander getExpander()
```
  - getKeyMaps
```
Map<String,org.graalvm.shadowed.org.jline.keymap.KeyMap<Binding>> getKeyMaps()
```
  - getKeyMap
```
String getKeyMap()
```
  - setKeyMap
```
boolean setKeyMap(String name)
```
  - getKeys
```
org.graalvm.shadowed.org.jline.keymap.KeyMap<Binding> getKeys()
```
  - getParsedLine
```
ParsedLine getParsedLine()
```
  - getSearchTerm
```
String getSearchTerm()
```
  - getRegionActive
```
LineReader.RegionType getRegionActive()
```
  - getRegionMark
```
int getRegionMark()
```
  - addCommandsInBuffer
```
void addCommandsInBuffer(Collection<String> commands)
```
  - editAndAddInBuffer
```
void editAndAddInBuffer(File file)
                 throws Exception
```
    Throws:
    
    Exception
  - getLastBinding
```
String getLastBinding()
```
  - getTailTip
```
String getTailTip()
```
  - setTailTip
```
void setTailTip(String tailTip)
```
  - setAutosuggestion
```
void setAutosuggestion(LineReader.SuggestionType type)
```
  - getAutosuggestion
```
LineReader.SuggestionType getAutosuggestion()
```

Interface LineReader

Thread safety

Prompt strings

Nested Class Summary

Field Summary

Method Summary

Field Detail

PROP_SUPPORT_PARSEDLINE

CALLBACK_INIT

CALLBACK_FINISH

CALLBACK_KEYMAP

ACCEPT_AND_INFER_NEXT_HISTORY

ACCEPT_AND_HOLD

ACCEPT_LINE

ACCEPT_LINE_AND_DOWN_HISTORY

ARGUMENT_BASE

BACKWARD_CHAR

BACKWARD_DELETE_CHAR

BACKWARD_DELETE_WORD

BACKWARD_KILL_LINE

BACKWARD_KILL_WORD

BACKWARD_WORD

BEEP

BEGINNING_OF_BUFFER_OR_HISTORY

BEGINNING_OF_HISTORY

BEGINNING_OF_LINE

BEGINNING_OF_LINE_HIST

CAPITALIZE_WORD

CHARACTER_SEARCH

CHARACTER_SEARCH_BACKWARD

CLEAR

CLEAR_SCREEN

COMPLETE_PREFIX

COMPLETE_WORD

COPY_PREV_WORD

COPY_REGION_AS_KILL

DELETE_CHAR

DELETE_CHAR_OR_LIST

DELETE_WORD

DIGIT_ARGUMENT

DO_LOWERCASE_VERSION

DOWN_CASE_WORD

DOWN_HISTORY

DOWN_LINE

DOWN_LINE_OR_HISTORY

DOWN_LINE_OR_SEARCH

EDIT_AND_EXECUTE_COMMAND

EMACS_BACKWARD_WORD

EMACS_EDITING_MODE

EMACS_FORWARD_WORD

END_OF_BUFFER_OR_HISTORY

END_OF_HISTORY

END_OF_LINE

END_OF_LINE_HIST

EXCHANGE_POINT_AND_MARK

EXECUTE_NAMED_CMD

EXPAND_HISTORY

EXPAND_OR_COMPLETE

EXPAND_OR_COMPLETE_PREFIX

EXPAND_WORD

FRESH_LINE

FORWARD_CHAR

FORWARD_WORD

HISTORY_BEGINNING_SEARCH_BACKWARD

HISTORY_BEGINNING_SEARCH_FORWARD

HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD

HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD

HISTORY_INCREMENTAL_SEARCH_BACKWARD

HISTORY_INCREMENTAL_SEARCH_FORWARD

HISTORY_SEARCH_BACKWARD

HISTORY_SEARCH_FORWARD

INSERT_CLOSE_CURLY

INSERT_CLOSE_PAREN

INSERT_CLOSE_SQUARE

INFER_NEXT_HISTORY

INSERT_COMMENT

INSERT_LAST_WORD

KILL_BUFFER

KILL_LINE

KILL_REGION