Top Description Inners Fields Methods
jdk.internal.org.jline.reader

public Interface LineReader

Known Direct Implementers
jdk.internal.org.jline.reader.impl.LineReaderImpl
Imports
java.io.File, .InputStream, java.util.Collection, .Map, java.util.function.IntConsumer, jdk.internal.org.jline.keymap.KeyMap, jdk.internal.org.jline.terminal.MouseEvent, .Terminal, jdk.internal.org.jline.utils.AttributedString
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 printAbove(String) or 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:

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 and Inner Type Summary

Modifier and TypeClass and Description
public static enum
LineReader.Option

public static enum
LineReader.RegionType

public static enum
LineReader.SuggestionType

Field Summary

Modifier and TypeField and Description
public static final String
ACCEPT_AND_HOLD

public static final String
ACCEPT_AND_INFER_NEXT_HISTORY

public static final String
ACCEPT_LINE

public static final String
ACCEPT_LINE_AND_DOWN_HISTORY

public static final String
AMBIGUOUS_BINDING

Timeout for ambiguous key sequences.

public static final String
ARGUMENT_BASE

public static final String
BACKWARD_CHAR

public static final String
BACKWARD_DELETE_CHAR

public static final String
BACKWARD_DELETE_WORD

public static final String
BACKWARD_KILL_LINE

public static final String
BACKWARD_KILL_WORD

public static final String
BACKWARD_WORD

public static final String
BEEP

public static final String
BEGIN_PASTE

public static final String
BEGINNING_OF_BUFFER_OR_HISTORY

public static final String
BEGINNING_OF_HISTORY

public static final String
BEGINNING_OF_LINE

public static final String
BEGINNING_OF_LINE_HIST

public static final String
BELL_STYLE

public static final String
BIND_TTY_SPECIAL_CHARS

public static final String
CALLBACK_FINISH

public static final String
CALLBACK_INIT

public static final String
CALLBACK_KEYMAP

public static final String
CAPITALIZE_WORD

public static final String
CHARACTER_SEARCH

public static final String
CHARACTER_SEARCH_BACKWARD

public static final String
CLEAR

public static final String
CLEAR_SCREEN

public static final String
COMMENT_BEGIN

public static final String
COMPLETE_PREFIX

public static final String
COMPLETE_WORD

public static final String
COMPLETION_STYLE_BACKGROUND

Completion style for displaying the list

public static final String
COMPLETION_STYLE_DESCRIPTION

Completion style for displaying the candidate description

public static final String
COMPLETION_STYLE_GROUP

Completion style for displaying groups name

public static final String
COMPLETION_STYLE_LIST_BACKGROUND

public static final String
COMPLETION_STYLE_LIST_DESCRIPTION

public static final String
COMPLETION_STYLE_LIST_GROUP

public static final String
COMPLETION_STYLE_LIST_SELECTION

public static final String
COMPLETION_STYLE_LIST_STARTING

public static final String
COMPLETION_STYLE_SELECTION

Completion style for displaying the current selected item

public static final String
COMPLETION_STYLE_STARTING

Completion style for displaying the matching part of candidates

public static final String
COPY_PREV_WORD

public static final String
COPY_REGION_AS_KILL

public static final String
DELETE_CHAR

public static final String
DELETE_CHAR_OR_LIST

public static final String
DELETE_WORD

public static final String
DIGIT_ARGUMENT

public static final String
DISABLE_COMPLETION

public static final String
DISABLE_HISTORY

public static final String
DO_LOWERCASE_VERSION

public static final String
DOWN_CASE_WORD

public static final String
DOWN_HISTORY

public static final String
DOWN_LINE

public static final String
DOWN_LINE_OR_HISTORY

public static final String
DOWN_LINE_OR_SEARCH

public static final String
DUMB

public static final String
EDIT_AND_EXECUTE_COMMAND

public static final String
EDITING_MODE

public static final String
EMACS

public static final String
EMACS_BACKWARD_WORD

public static final String
EMACS_EDITING_MODE

public static final String
EMACS_FORWARD_WORD

public static final String
END_OF_BUFFER_OR_HISTORY

public static final String
END_OF_HISTORY

public static final String
END_OF_LINE

public static final String
END_OF_LINE_HIST

public static final String
ERRORS

Number of matching errors that are accepted by the completion matcher

public static final String
EXCHANGE_POINT_AND_MARK

public static final String
EXECUTE_NAMED_CMD

public static final String
EXPAND_HISTORY

public static final String
EXPAND_OR_COMPLETE

public static final String
EXPAND_OR_COMPLETE_PREFIX

public static final String
EXPAND_WORD

public static final String
FEATURES_MAX_BUFFER_SIZE

Max buffer size for advanced features.

public static final String
FOCUS_IN

public static final String
FOCUS_OUT

public static final String
FORWARD_CHAR

public static final String
FORWARD_WORD

public static final String
FRESH_LINE

public static final String
HISTORY_BEGINNING_SEARCH_BACKWARD

public static final String
HISTORY_BEGINNING_SEARCH_FORWARD

public static final String
HISTORY_FILE

File system history path.

public static final String
HISTORY_FILE_SIZE

Number of history items to keep in the history file.

public static final String
HISTORY_IGNORE

Colon separated list of patterns that will not be saved in history.

public static final String
HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD

public static final String
HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD

public static final String
HISTORY_INCREMENTAL_SEARCH_BACKWARD

public static final String
HISTORY_INCREMENTAL_SEARCH_FORWARD

public static final String
HISTORY_SEARCH_BACKWARD

public static final String
HISTORY_SEARCH_FORWARD

public static final String
HISTORY_SIZE

Number of history items to keep in memory.

public static final String
INDENTATION

New line automatic indentation after opening/closing bracket.

public static final String
INFER_NEXT_HISTORY

public static final String
INPUT_RC_FILE_NAME

Name of inputrc to read at line reader creation time.

public static final String
INSERT_CLOSE_CURLY

public static final String
INSERT_CLOSE_PAREN

public static final String
INSERT_CLOSE_SQUARE

public static final String
INSERT_COMMENT

public static final String
INSERT_LAST_WORD

public static final String
KEYMAP

public static final String
KILL_BUFFER

public static final String
KILL_LINE

public static final String
KILL_REGION

public static final String
KILL_WHOLE_LINE

public static final String
KILL_WORD

public static final String
LINE_OFFSET

When in multiline edit mode, this variable can be used to offset the line number displayed.

public static final String
LIST_CHOICES

public static final String
LIST_EXPAND

public static final String
LIST_MAX

tab completion: if candidates are more than list-max a question will be asked before displaying them

public static final String
MAGIC_SPACE

public static final String
MAIN

public static final String
MAX_REPEAT_COUNT

Max number of times a command can be repeated.

public static final String
MOUSE

public static final String
NEG_ARGUMENT

public static final String
ORIGINAL_GROUP_NAME

Property for the "original" group name

public static final String
OTHERS_GROUP_NAME

Property for the "others" group name

public static final String
OVERWRITE_MODE

public static final String
PREFER_VISIBLE_BELL

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

public static final String
PUT_REPLACE_SELECTION

public static final String
QUOTED_INSERT

public static final String
READ_COMMAND

public static final String
RECURSIVE_EDIT

public static final String
REDISPLAY

public static final String
REDO

public static final String
REDRAW_LINE

public static final String
REMOVE_SUFFIX_CHARS

public static final String
REVERSE_MENU_COMPLETE

public static final String
SAFE

public static final String
SEARCH_TERMINATORS

public static final String
SECONDARY_PROMPT_PATTERN

Set the template for prompts for secondary (continuation) lines.

public static final String
SELF_INSERT

public static final String
SELF_INSERT_UNMETA

public static final String
SEND_BREAK

public static final String
SET_LOCAL_HISTORY

public static final String
SET_MARK_COMMAND

public static final String
SPELL_WORD

public static final String
SPLIT_UNDO

public static final String
SUGGESTIONS_MIN_BUFFER_SIZE

Min buffer size for tab auto-suggestions.

public static final String
SYSTEM_PROPERTY_PREFIX

Prefix to automatically delegate variables to system properties

public static final String
TAB_WIDTH

Number of spaces to display a tabulation, the default is 4.

public static final String
TRANSPOSE_CHARS

public static final String
TRANSPOSE_WORDS

public static final String
UNDEFINED_KEY

public static final String
UNDO

public static final String
UNIVERSAL_ARGUMENT

public static final String
UP_CASE_WORD

public static final String
UP_HISTORY

public static final String
UP_LINE

public static final String
UP_LINE_OR_HISTORY

public static final String
UP_LINE_OR_SEARCH

public static final String
VI_ADD_EOL

public static final String
VI_ADD_NEXT

public static final String
VI_BACKWARD_BLANK_WORD

public static final String
VI_BACKWARD_BLANK_WORD_END

public static final String
VI_BACKWARD_CHAR

public static final String
VI_BACKWARD_DELETE_CHAR

public static final String
VI_BACKWARD_KILL_WORD

public static final String
VI_BACKWARD_WORD

public static final String
VI_BACKWARD_WORD_END

public static final String
VI_BEGINNING_OF_LINE

public static final String
VI_CHANGE

public static final String
VI_CHANGE_EOL

public static final String
VI_CHANGE_WHOLE_LINE

public static final String
VI_CMD_MODE

public static final String
VI_DELETE

public static final String
VI_DELETE_CHAR

public static final String
VI_DIGIT_OR_BEGINNING_OF_LINE

public static final String
VI_DOWN_LINE_OR_HISTORY

public static final String
VI_END_OF_LINE

public static final String
VI_FETCH_HISTORY

public static final String
VI_FIND_NEXT_CHAR

public static final String
VI_FIND_NEXT_CHAR_SKIP

public static final String
VI_FIND_PREV_CHAR

public static final String
VI_FIND_PREV_CHAR_SKIP

public static final String
VI_FIRST_NON_BLANK

public static final String
VI_FORWARD_BLANK_WORD

public static final String
VI_FORWARD_BLANK_WORD_END

public static final String
VI_FORWARD_CHAR

public static final String
VI_FORWARD_WORD

public static final String
VI_FORWARD_WORD_END

public static final String
VI_GOTO_COLUMN

public static final String
VI_HISTORY_SEARCH_BACKWARD

public static final String
VI_HISTORY_SEARCH_FORWARD

public static final String
VI_INSERT

public static final String
VI_INSERT_BOL

public static final String
VI_INSERT_COMMENT

public static final String
VI_JOIN

public static final String
VI_KILL_EOL

public static final String
VI_KILL_LINE

public static final String
VI_MATCH_BRACKET

public static final String
VI_OPEN_LINE_ABOVE

public static final String
VI_OPEN_LINE_BELOW

public static final String
VI_OPER_SWAP_CASE

public static final String
VI_PUT_AFTER

public static final String
VI_PUT_BEFORE

public static final String
VI_QUOTED_INSERT

public static final String
VI_REPEAT_CHANGE

public static final String
VI_REPEAT_FIND

public static final String
VI_REPEAT_SEARCH

public static final String
VI_REPLACE

public static final String
VI_REPLACE_CHARS

public static final String
VI_REV_REPEAT_FIND

public static final String
VI_REV_REPEAT_SEARCH

public static final String
VI_SET_BUFFER

public static final String
VI_SUBSTITUTE

public static final String
VI_SWAP_CASE

public static final String
VI_UNDO_CHANGE

public static final String
VI_UP_LINE_OR_HISTORY

public static final String
VI_YANK

public static final String
VI_YANK_EOL

public static final String
VI_YANK_WHOLE_LINE

public static final String
VICMD

public static final String
VIINS

public static final String
VIOPP

public static final String
VISUAL

public static final String
VISUAL_LINE_MODE

public static final String
VISUAL_MODE

public static final String
WHAT_CURSOR_POSITION

public static final String
WORDCHARS

public static final String
YANK

public static final String
YANK_POP

Method Summary

Modifier and TypeMethod and Description
public void
addCommandsInBuffer(Collection<String> commands)

public void
callWidget(String name)

public Map<String, KeyMap<Binding>>
defaultKeyMaps()

public void
editAndAddInBuffer(File file)

public String
getAppName()

public LineReader.SuggestionType
getAutosuggestion()

public Buffer
getBuffer()

public Map<String, Widget>
getBuiltinWidgets()

public Expander
getExpander()

public Highlighter
getHighlighter()

public History
getHistory()

public String
getKeyMap()

public Map<String, KeyMap<Binding>>
getKeyMaps()

public KeyMap<Binding>
getKeys()

public String
getLastBinding()

public ParsedLine
getParsedLine()

public Parser
getParser()

public LineReader.RegionType
getRegionActive()

public int
getRegionMark()

public String
getSearchTerm()

public String
getTailTip()

public Terminal
getTerminal()

public Object
getVariable(String name)

public Map<String, Object>
getVariables()

public Map<String, Widget>
getWidgets()

public boolean

Returns:

true if there is an ongoing readLine() call.
isReading()

Check if a thread is currently in a readLine() call.

public boolean
isSet(LineReader.Option option)

public LineReader
option(LineReader.Option option, boolean value)

public void
printAbove(String
the string to print
str)

Prints a line above the prompt and redraw everything.

public void
printAbove(AttributedString
the string to print
str)

Prints a string before the prompt and redraw everything.

public String

Returns:

the line read
readLine()

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

public String

Returns:

A line that is read from the terminal, can never be null.
readLine(Character
The mask character, null or 0.
mask)

Read the next line with the specified character mask.

public String

Returns:

A line that is read from the terminal, can never be null.
readLine(String
The prompt to issue to the terminal, may be null.
prompt)

Read the next line with the specified prompt.

public String

Returns:

A line that is read from the terminal, can never be null.
readLine(String
The prompt to issue to the terminal, may be null.
prompt, Character
The mask character, null or 0.
mask)

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

public String

Returns:

A line that is read from the terminal, can never be null.
readLine(String
The prompt to issue to the terminal, may be null. This is a template, with optional '%' escapes, as described in the class header.
prompt, Character
The character mask, may be null.
mask, String
The default value presented to the user to edit, may be null.
buffer)

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

public String

Returns:

A line that is read from the terminal, can never be null.
readLine(String
The prompt to issue to the terminal, may be null. This is a template, with optional '%' escapes, as described in the class header.
prompt, String
The right prompt This is a template, with optional '%' escapes, as described in the class header.
rightPrompt, Character
The character mask, may be null.
mask, String
The default value presented to the user to edit, may be null.
buffer)

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

public String

Returns:

A line that is read from the terminal, can never be null.
readLine(String
The prompt to issue to the terminal, may be null. This is a template, with optional '%' escapes, as described in the class header.
prompt, String
The right prompt This is a template, with optional '%' escapes, as described in the class header.
rightPrompt, MaskingCallback
The MaskingCallback to use when displaying lines and adding them to the line History
maskingCallback, String
The default value presented to the user to edit, may be null.
buffer)

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

public MouseEvent

Returns:

the mouse event
readMouseEvent()

Read a mouse event when the org.jline.utils.InfoCmp.Capability#key_mouse sequence has just been read on the input stream.

public void
runMacro(String
the key sequence to push back
macro)

Push back a key sequence that will be later consumed by the line reader.

public void
setAutosuggestion(LineReader.SuggestionType type)

public boolean
setKeyMap(String name)

public void
setOpt(LineReader.Option option)

public void
setTailTip(String tailTip)

public void
setVariable(String name, Object value)

public void
unsetOpt(LineReader.Option option)

public LineReader
variable(String name, Object value)

public void
zeroOut()

Clear any internal buffers.