Package org.jline.reader.impl

Class LineReaderImpl

java.lang.Object

org.jline.reader.impl.LineReaderImpl

All Implemented Interfaces:

Flushable, LineReader

public class LineReaderImpl
extends Object
implements LineReader, Flushable

The default implementation of the LineReader interface.

This class provides a comprehensive implementation of line editing capabilities for interactive terminal applications, including:

• Command history navigation and management
• Tab completion with customizable completion strategies
• Syntax highlighting
• Emacs and Vi editing modes
• Key binding customization
• Cut and paste with kill ring
• Undo/redo functionality
• Search through history
• Multi-line editing
• Character masking for password input

This implementation is highly configurable through options and variables that control various aspects of its behavior. It also provides a rich set of widgets (editing functions) that can be bound to key sequences.

Most applications should not create instances of this class directly, but instead use the LineReaderBuilder to create properly configured instances.

See Also:

• LineReader
• LineReaderBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	LineReaderImpl.BellType
protected static enum	LineReaderImpl.CompletionType
protected static class	LineReaderImpl.PostResult
protected static enum	LineReaderImpl.State	Possible states in which the current readline operation may be in.
protected static enum	LineReaderImpl.ViMoveMode

Nested classes/interfaces inherited from interface org.jline.reader.LineReader

LineReader.Option, LineReader.RegionType, LineReader.SuggestionType

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alternateIn
protected String	alternateOut
protected final String	appName	The application name
protected LineReader.SuggestionType	autosuggestion
protected final BindingReader	bindingReader
static final String	BRACKETED_PASTE_BEGIN
static final String	BRACKETED_PASTE_END
static final String	BRACKETED_PASTE_OFF
static final String	BRACKETED_PASTE_ON
protected final Buffer	buf
protected Map<String,Widget>	builtinWidgets
protected int	candidateStartPosition
protected List<String>	commandsBuffer
protected Completer	completer
protected CompletionMatcher	completionMatcher
protected int	count
protected int	currentLine
static final long	DEFAULT_AMBIGUOUS_BINDING
static final String	DEFAULT_BELL_STYLE
static final long	DEFAULT_BLINK_MATCHING_PAREN
static final String	DEFAULT_COMMENT_BEGIN
static final String	DEFAULT_COMPLETION_STYLE_BACKGROUND
static final String	DEFAULT_COMPLETION_STYLE_DESCRIPTION
static final String	DEFAULT_COMPLETION_STYLE_GROUP
static final String	DEFAULT_COMPLETION_STYLE_LIST_BACKGROUND
static final String	DEFAULT_COMPLETION_STYLE_LIST_DESCRIPTION
static final String	DEFAULT_COMPLETION_STYLE_LIST_GROUP
static final String	DEFAULT_COMPLETION_STYLE_LIST_SELECTION
static final String	DEFAULT_COMPLETION_STYLE_LIST_STARTING
static final String	DEFAULT_COMPLETION_STYLE_SELECTION
static final String	DEFAULT_COMPLETION_STYLE_STARTING
static final int	DEFAULT_ERRORS
static final int	DEFAULT_FEATURES_MAX_BUFFER_SIZE
static final int	DEFAULT_INDENTATION
static final int	DEFAULT_LIST_MAX
static final int	DEFAULT_MAX_REPEAT_COUNT
static final int	DEFAULT_MENU_LIST_MAX
static final String	DEFAULT_ORIGINAL_GROUP_NAME
static final String	DEFAULT_OTHERS_GROUP_NAME
static final String	DEFAULT_REMOVE_SUFFIX_CHARS
static final String	DEFAULT_SEARCH_TERMINATORS
static final String	DEFAULT_SECONDARY_PROMPT_PATTERN
static final int	DEFAULT_SUGGESTIONS_MIN_BUFFER_SIZE
static final String	DEFAULT_SYSTEM_PROPERTY_PREFIX
static final int	DEFAULT_TAB_WIDTH
static final String	DEFAULT_WORDCHARS
protected org.jline.utils.Display	display
protected boolean	doAutosuggestion
protected Expander	expander
protected int	findChar	VI character find
protected int	findDir
protected int	findTailAdd
static final String	FOCUS_IN_SEQ
static final String	FOCUS_OUT_SEQ
protected Highlighter	highlighter
protected History	history
protected Buffer	historyBuffer
protected boolean	isArgDigit
protected boolean	isUndo
protected String	keyMap
protected final Map<String,KeyMap<Binding>>	keyMaps	The terminal keys mapping
protected KillRing	killRing
protected int	lastStatusSize
protected final ReentrantLock	lock	State lock
protected MaskingCallback	maskingCallback
protected Thread	maskThread
protected Map<Integer,String>	modifiedHistory
protected int	mult
protected boolean	nextCommandFromHistory
protected int	nextHistoryId
static final char	NULL_MASK
protected final Map<LineReader.Option,Boolean>	options
protected boolean	overTyping
protected ParsedLine	parsedLine
protected Parser	parser
protected Supplier<org.jline.utils.AttributedString>	post
protected org.jline.utils.AttributedString	prompt
protected boolean	reading
protected LineReader.RegionType	regionActive
protected int	regionMark	Region state
protected int	repeatCount
protected org.jline.utils.AttributedString	rightPrompt
protected boolean	searchBackward
protected CharSequence	searchBuffer
protected boolean	searchFailing
protected int	searchIndex
protected StringBuffer	searchTerm
protected final org.jline.terminal.Size	size
protected boolean	skipRedisplay
protected int	smallTerminalOffset
protected final AtomicBoolean	startedReading
protected LineReaderImpl.State	state
static final int	TAB_WIDTH	Deprecated. use DEFAULT_TAB_WIDTH and getTabWidth()
protected String	tailTip
protected final org.jline.terminal.Terminal	terminal	The terminal to use
protected UndoTree<Buffer>	undo
protected int	universal
protected final Map<String,Object>	variables
protected LineReaderImpl.ViMoveMode	viMoveMode
protected Map<String,Widget>	widgets
protected String	yankBuffer	The vi yank buffer

Fields inherited from interface org.jline.reader.LineReader

ACCEPT_AND_HOLD, ACCEPT_AND_INFER_NEXT_HISTORY, ACCEPT_LINE, ACCEPT_LINE_AND_DOWN_HISTORY, AMBIGUOUS_BINDING, ARGUMENT_BASE, BACKWARD_CHAR, BACKWARD_DELETE_CHAR, BACKWARD_DELETE_WORD, BACKWARD_KILL_LINE, BACKWARD_KILL_WORD, BACKWARD_WORD, BEEP, BEGIN_PASTE, BEGINNING_OF_BUFFER_OR_HISTORY, BEGINNING_OF_HISTORY, BEGINNING_OF_LINE, BEGINNING_OF_LINE_HIST, BELL_STYLE, BIND_TTY_SPECIAL_CHARS, BLINK_MATCHING_PAREN, CALLBACK_FINISH, CALLBACK_INIT, CALLBACK_KEYMAP, CAPITALIZE_WORD, CHARACTER_SEARCH, CHARACTER_SEARCH_BACKWARD, CLEAR, CLEAR_SCREEN, COMMENT_BEGIN, COMPLETE_PREFIX, COMPLETE_WORD, COMPLETION_STYLE_BACKGROUND, COMPLETION_STYLE_DESCRIPTION, COMPLETION_STYLE_GROUP, COMPLETION_STYLE_LIST_BACKGROUND, COMPLETION_STYLE_LIST_DESCRIPTION, COMPLETION_STYLE_LIST_GROUP, COMPLETION_STYLE_LIST_SELECTION, COMPLETION_STYLE_LIST_STARTING, COMPLETION_STYLE_SELECTION, COMPLETION_STYLE_STARTING, COPY_PREV_WORD, COPY_REGION_AS_KILL, DELETE_CHAR, DELETE_CHAR_OR_LIST, DELETE_WORD, DIGIT_ARGUMENT, DISABLE_COMPLETION, DISABLE_HISTORY, DO_LOWERCASE_VERSION, DOWN_CASE_WORD, DOWN_HISTORY, DOWN_LINE, DOWN_LINE_OR_HISTORY, DOWN_LINE_OR_SEARCH, DUMB, EDIT_AND_EXECUTE_COMMAND, EDITING_MODE, EMACS, EMACS_BACKWARD_WORD, EMACS_EDITING_MODE, EMACS_FORWARD_WORD, END_OF_BUFFER_OR_HISTORY, END_OF_HISTORY, END_OF_LINE, END_OF_LINE_HIST, ERRORS, EXCHANGE_POINT_AND_MARK, EXECUTE_NAMED_CMD, EXPAND_HISTORY, EXPAND_OR_COMPLETE, EXPAND_OR_COMPLETE_PREFIX, EXPAND_WORD, FEATURES_MAX_BUFFER_SIZE, FOCUS_IN, FOCUS_OUT, FORWARD_CHAR, FORWARD_WORD, FRESH_LINE, HISTORY_BEGINNING_SEARCH_BACKWARD, HISTORY_BEGINNING_SEARCH_FORWARD, HISTORY_FILE, HISTORY_FILE_SIZE, HISTORY_IGNORE, HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD, HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD, HISTORY_INCREMENTAL_SEARCH_BACKWARD, HISTORY_INCREMENTAL_SEARCH_FORWARD, HISTORY_SEARCH_BACKWARD, HISTORY_SEARCH_FORWARD, HISTORY_SIZE, INDENTATION, INFER_NEXT_HISTORY, INPUT_RC_FILE_NAME, INSERT_CLOSE_CURLY, INSERT_CLOSE_PAREN, INSERT_CLOSE_SQUARE, INSERT_COMMENT, INSERT_LAST_WORD, KEYMAP, KILL_BUFFER, KILL_LINE, KILL_REGION, KILL_WHOLE_LINE, KILL_WORD, LINE_OFFSET, LIST_CHOICES, LIST_EXPAND, LIST_MAX, MAGIC_SPACE, MAIN, MAX_REPEAT_COUNT, MENU, MENU_COMPLETE, MENU_EXPAND_OR_COMPLETE, MENU_LIST_MAX, MENU_SELECT, MOUSE, NEG_ARGUMENT, ORIGINAL_GROUP_NAME, OTHERS_GROUP_NAME, OVERWRITE_MODE, PREFER_VISIBLE_BELL, PROP_SUPPORT_PARSEDLINE, PUT_REPLACE_SELECTION, QUOTED_INSERT, READ_COMMAND, RECURSIVE_EDIT, REDISPLAY, REDO, REDRAW_LINE, REMOVE_SUFFIX_CHARS, REVERSE_MENU_COMPLETE, SAFE, SEARCH_TERMINATORS, SECONDARY_PROMPT_PATTERN, SELF_INSERT, SELF_INSERT_UNMETA, SEND_BREAK, SET_LOCAL_HISTORY, SET_MARK_COMMAND, SPELL_WORD, SPLIT_UNDO, SUGGESTIONS_MIN_BUFFER_SIZE, SYSTEM_PROPERTY_PREFIX, TRANSPOSE_CHARS, TRANSPOSE_WORDS, UNDEFINED_KEY, UNDO, UNIVERSAL_ARGUMENT, UP_CASE_WORD, UP_HISTORY, UP_LINE, UP_LINE_OR_HISTORY, UP_LINE_OR_SEARCH, VI_ADD_EOL, VI_ADD_NEXT, VI_BACKWARD_BLANK_WORD, VI_BACKWARD_BLANK_WORD_END, VI_BACKWARD_CHAR, VI_BACKWARD_DELETE_CHAR, VI_BACKWARD_KILL_WORD, VI_BACKWARD_WORD, VI_BACKWARD_WORD_END, VI_BEGINNING_OF_LINE, VI_CHANGE, VI_CHANGE_EOL, VI_CHANGE_WHOLE_LINE, VI_CMD_MODE, VI_DELETE, VI_DELETE_CHAR, VI_DIGIT_OR_BEGINNING_OF_LINE, VI_DOWN_LINE_OR_HISTORY, VI_END_OF_LINE, VI_FETCH_HISTORY, VI_FIND_NEXT_CHAR, VI_FIND_NEXT_CHAR_SKIP, VI_FIND_PREV_CHAR, VI_FIND_PREV_CHAR_SKIP, VI_FIRST_NON_BLANK, VI_FORWARD_BLANK_WORD, VI_FORWARD_BLANK_WORD_END, VI_FORWARD_CHAR, VI_FORWARD_WORD, VI_FORWARD_WORD_END, VI_GOTO_COLUMN, VI_HISTORY_SEARCH_BACKWARD, VI_HISTORY_SEARCH_FORWARD, VI_INSERT, VI_INSERT_BOL, VI_INSERT_COMMENT, VI_JOIN, VI_KILL_EOL, VI_KILL_LINE, VI_MATCH_BRACKET, VI_OPEN_LINE_ABOVE, VI_OPEN_LINE_BELOW, VI_OPER_SWAP_CASE, VI_PUT_AFTER, VI_PUT_BEFORE, VI_QUOTED_INSERT, VI_REPEAT_CHANGE, VI_REPEAT_FIND, VI_REPEAT_SEARCH, VI_REPLACE, VI_REPLACE_CHARS, VI_REV_REPEAT_FIND, VI_REV_REPEAT_SEARCH, VI_SET_BUFFER, VI_SUBSTITUTE, VI_SWAP_CASE, VI_UNDO_CHANGE, VI_UP_LINE_OR_HISTORY, VI_YANK, VI_YANK_EOL, VI_YANK_WHOLE_LINE, VICMD, VIINS, VIOPP, VISUAL, VISUAL_LINE_MODE, VISUAL_MODE, WHAT_CURSOR_POSITION, WORDCHARS, YANK, YANK_POP

Constructor Summary

Constructors

Constructor	Description
LineReaderImpl(org.jline.terminal.Terminal terminal)
LineReaderImpl(org.jline.terminal.Terminal terminal, String appName)
LineReaderImpl(org.jline.terminal.Terminal terminal, String appName, Map<String,Object> variables)

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptAndHold()
protected boolean	acceptAndInferNextHistory()
protected boolean	acceptLine()
protected boolean	acceptLineAndDownHistory()
void	addCommandsInBuffer(Collection<String> commands)	Adds a collection of commands to the input buffer for execution.
protected boolean	argumentBase()
protected boolean	backwardChar()
protected boolean	backwardDeleteChar()
protected boolean	backwardDeleteWord()
boolean	backwardKillLine()
protected boolean	backwardKillWord()
protected boolean	backwardWord()
boolean	beep()	Issue an audible keyboard bell.
protected boolean	beginningOfBufferOrHistory()
protected boolean	beginningOfHistory()
protected boolean	beginningOfLine()
protected boolean	beginningOfLineHist()
boolean	beginPaste()
protected org.jline.utils.AttributedStyle	buildStyle(String str)
protected Map<String,Widget>	builtinWidgets()
void	callWidget(String name)	Calls a widget by name.
protected boolean	capitalizeWord()
protected void	cleanup()
boolean	clear()	Clean the used display
protected boolean	clearChoices()
boolean	clearScreen()	Clear the screen by issuing the ANSI "clear screen" code.
protected boolean	completePrefix()
protected boolean	completeWord()
protected LineReaderImpl.PostResult	computePost(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed)
protected LineReaderImpl.PostResult	computePost(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed, Function<String,Integer> wcwidth, int width, boolean autoGroup, boolean groupName, boolean rowsFirst)
protected boolean	copyPrevWord()
boolean	copyRegionAsKill()
protected boolean	deactivateRegion()
Map<String,KeyMap<Binding>>	defaultKeyMaps()	Returns the default key maps used by the LineReader.
protected boolean	deleteChar()
protected boolean	deleteCharOrList()
protected boolean	deleteWord()
protected boolean	digitArgument()
protected void	doCleanup(boolean nl)
protected boolean	doComplete(LineReaderImpl.CompletionType lst, boolean useMenu, boolean prefix)
protected boolean	doComplete(LineReaderImpl.CompletionType lst, boolean useMenu, boolean prefix, boolean forSuggestion)
protected boolean	doInsertComment(boolean isViMode)
protected boolean	doList(List<Candidate> possible, String completed, boolean runLoop, BiFunction<CharSequence,Boolean,CharSequence> escaper)
protected boolean	doList(List<Candidate> possible, String completed, boolean runLoop, BiFunction<CharSequence,Boolean,CharSequence> escaper, boolean forSuggestion)
protected boolean	doLowercaseVersion()
protected boolean	doMenu(List<Candidate> original, String completed, BiFunction<CharSequence,Boolean,CharSequence> escaper)
protected <T> T	doReadBinding(KeyMap<T> keys, KeyMap<T> local)
protected String	doReadStringUntil(String sequence)
protected boolean	doSearchHistory(boolean backward)
protected boolean	doViDeleteOrChange(int startPos, int endPos, boolean isChange)	Performs the vi "delete-to" action, deleting characters between a given span of the input line.
protected boolean	doViMatchBracket()	Implements vi style bracket matching ("%" command).
protected boolean	downCaseWord()
protected boolean	downHistory()
protected boolean	downLine()
protected boolean	downLineOrHistory()
protected boolean	downLineOrSearch()
KeyMap<Binding>	dumb()
void	editAndAddInBuffer(Path file)	Opens a file in an external editor and adds its contents to the input buffer.
protected boolean	editAndExecute()
KeyMap<Binding>	emacs()
protected boolean	emacsBackwardWord()
protected boolean	emacsEditingMode()
protected boolean	emacsForwardWord()
protected boolean	endOfBufferOrHistory()
protected boolean	endOfHistory()
protected boolean	endOfLine()
protected boolean	endOfLineHist()
protected boolean	exchangePointAndMark()
protected boolean	expandHistory()
protected boolean	expandOrComplete()
protected boolean	expandOrCompletePrefix()
protected boolean	expandWord()
protected String	finish(String str)
protected String	finishBuffer()	Clear the buffer and add its contents to the history.
void	flush()	Flush the terminal output stream.
boolean	focusIn()
boolean	focusOut()
protected boolean	forwardChar()
protected boolean	forwardWord()
protected boolean	freshLine()
String	getAppName()	Returns the application name associated with this LineReader.
LineReader.SuggestionType	getAutosuggestion()	Returns the current auto-suggestion type.
protected int	getBracketType(int ch)	Given a character determines what type of bracket it is (paren, square, curly, or none).
Buffer	getBuffer()	Returns the current line buffer.
Map<String,Widget>	getBuiltinWidgets()	Returns a map of all built-in widgets provided by the LineReader.
protected Comparator<Candidate>	getCandidateComparator(boolean caseInsensitive, String word)
Completer	getCompleter()	Returns the completer.
protected org.jline.utils.AttributedStyle	getCompletionStyle(String name, String value)
protected org.jline.utils.AttributedStyle	getCompletionStyleBackground()
protected org.jline.utils.AttributedStyle	getCompletionStyleBackground(boolean menuList)
protected org.jline.utils.AttributedStyle	getCompletionStyleDescription()
protected org.jline.utils.AttributedStyle	getCompletionStyleDescription(boolean menuList)
protected org.jline.utils.AttributedStyle	getCompletionStyleGroup()
protected org.jline.utils.AttributedStyle	getCompletionStyleGroup(boolean menuList)
protected org.jline.utils.AttributedStyle	getCompletionStyleListBackground()
protected org.jline.utils.AttributedStyle	getCompletionStyleListDescription()
protected org.jline.utils.AttributedStyle	getCompletionStyleListGroup()
protected org.jline.utils.AttributedStyle	getCompletionStyleListSelection()
protected org.jline.utils.AttributedStyle	getCompletionStyleListStarting()
protected org.jline.utils.AttributedStyle	getCompletionStyleSelection()
protected org.jline.utils.AttributedStyle	getCompletionStyleSelection(boolean menuList)
protected org.jline.utils.AttributedStyle	getCompletionStyleStarting()
protected org.jline.utils.AttributedStyle	getCompletionStyleStarting(boolean menuList)
org.jline.utils.AttributedString	getDisplayedBufferWithPrompts(List<org.jline.utils.AttributedString> secondaryPrompts)	Compute the full string to be displayed with the left, right and secondary prompts
Expander	getExpander()	Returns the expander associated with this LineReader.
protected Comparator<String>	getGroupComparator()
Highlighter	getHighlighter()	Returns the highlighter associated with this LineReader.
History	getHistory()	Returns the history associated with this LineReader.
String	getKeyMap()	Returns the name of the current key mapping.
Map<String,KeyMap<Binding>>	getKeyMaps()	Returns all key maps registered with this LineReader.
KeyMap<Binding>	getKeys()	Returns the currently active key map.
String	getLastBinding()	Returns the last key binding that was processed.
protected String	getOriginalGroupName()
protected String	getOthersGroupName()
ParsedLine	getParsedLine()	Returns the parsed representation of the current line.
Parser	getParser()	Returns the parser associated with this LineReader.
LineReader.RegionType	getRegionActive()	Returns the type of the currently active region selection.
int	getRegionMark()	Returns the mark position of the currently active region.
String	getSearchTerm()	Returns the current search term when in history search mode.
protected int	getTabWidth()
String	getTailTip()	Returns the current tail tip text.
org.jline.terminal.Terminal	getTerminal()	Returns the terminal associated with this LineReader.
Object	getVariable(String name)	Returns the value of a variable.
Map<String,Object>	getVariables()	Returns a map of all variables set in the LineReader.
protected Widget	getWidget(Object binding)
Map<String,Widget>	getWidgets()	Returns a map of all widgets registered with this LineReader.
protected void	handleSignal(org.jline.terminal.Terminal.Signal signal)
protected boolean	historyIncrementalSearchBackward()
protected boolean	historyIncrementalSearchForward()
protected boolean	historySearchBackward()
protected boolean	historySearchForward()
protected boolean	insertClose(String s)
protected boolean	insertCloseCurly()
protected boolean	insertCloseParen()
protected boolean	insertCloseSquare()
protected boolean	insertComment()
protected boolean	insertTab()
protected boolean	isAlpha(int c)
protected boolean	isDelimiter(int c)	Checks to see if the specified character is a delimiter.
protected boolean	isInViChangeOperation()
protected boolean	isInViCmdMode()
protected boolean	isInViMoveOperation()
boolean	isKeyMap(String name)
boolean	isReading()	Check if a thread is currently in a readLine() call.
boolean	isSet(LineReader.Option option)	Checks if an option is set.
protected boolean	isViAlphaNum(int c)
protected boolean	isWhitespace(int c)	Checks to see if a character is a whitespace character.
protected boolean	isWord(int c)
protected boolean	killBuffer()
boolean	killLine()	Kill the buffer ahead of the current cursor position.
boolean	killRegion()
protected boolean	killWholeLine()
protected boolean	killWord()
protected boolean	listChoices()
KeyMap<Binding>	menu()
protected boolean	menuComplete()
protected boolean	menuExpandOrComplete()
boolean	mouse()
protected boolean	moveHistory(boolean next)	Move up or down the history tree.
protected boolean	moveHistory(boolean next, int count)	Used in "vi" mode for argumented history move, to move a specific number of history entries forward or back.
protected boolean	negArgument()
protected boolean	nextBindingIsComplete()
LineReader	option(LineReader.Option option, boolean value)	Sets an option in the LineReader and returns the LineReader for method chaining.
protected boolean	overwriteMode()
int	peekCharacter(long timeout)
void	printAbove(String str)	Prints a line above the prompt and redraw everything.
void	printAbove(org.jline.utils.AttributedString str)	Prints a string before the prompt and redraw everything.
void	putString(CharSequence str)	Write out the specified string to the buffer and the output stream.
protected boolean	quit()
protected boolean	quotedInsert()
Binding	readBinding(KeyMap<Binding> keys)	Read from the input stream and decode an operation from the key map.
Binding	readBinding(KeyMap<Binding> keys, KeyMap<Binding> local)
int	readCharacter()	Read a character from the terminal.
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 a line from the in InputStream, and return the line (without any trailing newlines).
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.jline.terminal.MouseEvent	readMouseEvent()	Read a mouse event when the InfoCmp.Capability.key_mouse sequence has just been read on the input stream.
boolean	redisplay()
protected void	redisplay(boolean flush)
protected boolean	redo()
boolean	redrawLine()	Clear the line and redraw it.
void	runMacro(String macro)	Push back a key sequence that will be later consumed by the line reader.
KeyMap<Binding>	safe()
int	searchBackwards(String searchTerm)	Search backwards in history from the current position.
int	searchBackwards(String searchTerm, int startIndex)	Search backward in history from a given position.
int	searchBackwards(String searchTerm, int startIndex, boolean startsWith)
int	searchForwards(String searchTerm)	Search forwards in history from the current position.
int	searchForwards(String searchTerm, int startIndex)	Search forward in history from a given position.
int	searchForwards(String searchTerm, int startIndex, boolean startsWith)
protected boolean	selfInsert()
protected boolean	selfInsertUnmeta()
protected boolean	sendBreak()
void	setAutosuggestion(LineReader.SuggestionType type)	Sets the type of auto-suggestion to use.
protected void	setBuffer(String buffer)	Set the current buffer's content to the specified String.
protected void	setBuffer(Buffer buffer)
void	setCompleter(Completer completer)	Set the completer.
void	setCompletionMatcher(CompletionMatcher completionMatcher)
void	setExpander(Expander expander)
void	setHighlighter(Highlighter highlighter)
void	setHistory(History history)
boolean	setKeyMap(String name)	Sets the current keymap by name.
protected boolean	setMarkCommand()
void	setOpt(LineReader.Option option)	Sets an option to true.
void	setParser(Parser parser)
void	setPrompt(String prompt)
void	setRightPrompt(String rightPrompt)
void	setTailTip(String tailTip)	Sets the tail tip text.
void	setVariable(String name, Object value)	Sets a variable in the LineReader.
protected int	switchCase(int ch)
protected void	toColumns(Object items, int width, int maxWidth, org.jline.utils.AttributedStringBuilder sb, Candidate selection, String completed, boolean rowsFirst, boolean doMenuList, int[] out)
protected LineReaderImpl.PostResult	toColumns(List<Object> items, Candidate selection, String completed, Function<String,Integer> wcwidth, int width, boolean rowsFirst)
protected boolean	transposeChars()	Performs character transpose.
protected boolean	transposeWords()
protected boolean	undefinedKey()
protected boolean	undo()
protected boolean	universalArgument()
void	unsetOpt(LineReader.Option option)	Sets an option to false.
protected boolean	upCaseWord()
protected boolean	upHistory()
protected boolean	upLine()
protected boolean	upLineOrHistory()
protected boolean	upLineOrSearch()
LineReader	variable(String name, Object value)	Sets a variable in the LineReader and returns the LineReader for method chaining.
protected boolean	viAddEol()
protected boolean	viAddNext()
protected boolean	viBackwardBlankWord()
protected boolean	viBackwardBlankWordEnd()
protected boolean	viBackwardChar()
protected boolean	viBackwardDeleteChar()	Deletes the previous character from the cursor position
protected boolean	viBackwardKillWord()
protected boolean	viBackwardWord()
protected boolean	viBackwardWordEnd()
protected boolean	viBeginningOfLine()
protected boolean	viChange()
protected boolean	viChange(int startPos, int endPos)
protected boolean	viChangeEol()
protected boolean	viChangeWholeLine()
KeyMap<Binding>	viCmd()
protected boolean	viCmdMode()
protected boolean	viDelete()
protected String	viDeleteChangeYankToRemap(String op)	This method is calling while doing a delete-to ("d"), change-to ("c"), or yank-to ("y") and it filters out only those movement operations that are allowable during those operations.
protected boolean	viDeleteChar()	Deletes the character you are sitting on and sucks the rest of the line in from the right.
protected boolean	viDeleteTo(int startPos, int endPos)
protected boolean	viDigitOrBeginningOfLine()
protected boolean	viDownLineOrHistory()
protected boolean	viEndOfLine()
protected boolean	viFindNextChar()
protected boolean	viFindNextCharSkip()
protected boolean	viFindPrevChar()
protected boolean	viFindPrevCharSkip()
protected boolean	viFirstNonBlank()
protected boolean	viForwardBlankWord()
protected boolean	viForwardBlankWordEnd()
protected boolean	viForwardChar()
protected boolean	viForwardWord()
protected boolean	viForwardWordEnd()
protected boolean	viHistorySearchBackward()
protected boolean	viHistorySearchForward()	Implements vi search ("/" or "?").
protected boolean	viInsert()
protected boolean	viInsertBol()
protected boolean	viInsertComment()
KeyMap<Binding>	viInsertion()
protected boolean	viJoin()
protected boolean	viKillEol()
protected boolean	viKillWholeLine()
protected boolean	viMatchBracket()
protected boolean	viOpenLineAbove()
protected boolean	viOpenLineBelow()
KeyMap<Binding>	viOpp()
protected boolean	viPutAfter()	Pasts the yank buffer to the right of the current cursor position and moves the cursor to the end of the pasted region.
protected boolean	viPutBefore()
protected boolean	viRepeatFind()
protected boolean	viRepeatSearch()
protected boolean	viReplaceChars()	Implements the vi change character command (in move-mode "r" followed by the character to change to).
protected boolean	viRevRepeatFind()
protected boolean	viRevRepeatSearch()
KeyMap<Binding>	visual()
protected boolean	visualLineMode()
protected boolean	visualMode()
protected boolean	viSwapCase()	Switches the case of the current character from upper to lower or lower to upper as necessary and advances the cursor one position to the right.
protected boolean	viUpLineOrHistory()
protected boolean	viYankTo()
protected boolean	viYankTo(int startPos, int endPos)	Implement the "vi" yank-to operation.
protected boolean	viYankWholeLine()
protected boolean	whatCursorPosition()
protected static CompletingParsedLine	wrap(ParsedLine line)
boolean	yank()
boolean	yankPop()
void	zeroOut()	Clears any internal buffers and sensitive data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jline.reader.LineReader

editAndAddInBuffer

Field Details

NULL_MASK

public static final char NULL_MASK

See Also:

• Constant Field Values

TAB_WIDTH

@Deprecated
public static final int TAB_WIDTH

Deprecated.

use DEFAULT_TAB_WIDTH and getTabWidth()

See Also:

• Constant Field Values

DEFAULT_TAB_WIDTH

public static final int DEFAULT_TAB_WIDTH

See Also:

• Constant Field Values

DEFAULT_WORDCHARS

public static final String DEFAULT_WORDCHARS

See Also:

• Constant Field Values

DEFAULT_REMOVE_SUFFIX_CHARS

public static final String DEFAULT_REMOVE_SUFFIX_CHARS

See Also:

• Constant Field Values

DEFAULT_COMMENT_BEGIN

public static final String DEFAULT_COMMENT_BEGIN

See Also:

• Constant Field Values

DEFAULT_SEARCH_TERMINATORS

public static final String DEFAULT_SEARCH_TERMINATORS

See Also:

• Constant Field Values

DEFAULT_BELL_STYLE

public static final String DEFAULT_BELL_STYLE

See Also:

• Constant Field Values

DEFAULT_LIST_MAX

public static final int DEFAULT_LIST_MAX

See Also:

• Constant Field Values

DEFAULT_MENU_LIST_MAX

public static final int DEFAULT_MENU_LIST_MAX

See Also:

• Constant Field Values

DEFAULT_ERRORS

public static final int DEFAULT_ERRORS

See Also:

• Constant Field Values

DEFAULT_BLINK_MATCHING_PAREN

public static final long DEFAULT_BLINK_MATCHING_PAREN

See Also:

• Constant Field Values

DEFAULT_AMBIGUOUS_BINDING

public static final long DEFAULT_AMBIGUOUS_BINDING

See Also:

• Constant Field Values

DEFAULT_SECONDARY_PROMPT_PATTERN

public static final String DEFAULT_SECONDARY_PROMPT_PATTERN

See Also:

• Constant Field Values

DEFAULT_OTHERS_GROUP_NAME

public static final String DEFAULT_OTHERS_GROUP_NAME

See Also:

• Constant Field Values

DEFAULT_ORIGINAL_GROUP_NAME

public static final String DEFAULT_ORIGINAL_GROUP_NAME

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_STARTING

public static final String DEFAULT_COMPLETION_STYLE_STARTING

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_DESCRIPTION

public static final String DEFAULT_COMPLETION_STYLE_DESCRIPTION

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_GROUP

public static final String DEFAULT_COMPLETION_STYLE_GROUP

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_SELECTION

public static final String DEFAULT_COMPLETION_STYLE_SELECTION

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_BACKGROUND

public static final String DEFAULT_COMPLETION_STYLE_BACKGROUND

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_LIST_STARTING

public static final String DEFAULT_COMPLETION_STYLE_LIST_STARTING

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_LIST_DESCRIPTION

public static final String DEFAULT_COMPLETION_STYLE_LIST_DESCRIPTION

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_LIST_GROUP

public static final String DEFAULT_COMPLETION_STYLE_LIST_GROUP

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_LIST_SELECTION

public static final String DEFAULT_COMPLETION_STYLE_LIST_SELECTION

See Also:

• Constant Field Values

DEFAULT_COMPLETION_STYLE_LIST_BACKGROUND

public static final String DEFAULT_COMPLETION_STYLE_LIST_BACKGROUND

See Also:

• Constant Field Values

DEFAULT_INDENTATION

public static final int DEFAULT_INDENTATION

See Also:

• Constant Field Values

DEFAULT_FEATURES_MAX_BUFFER_SIZE

public static final int DEFAULT_FEATURES_MAX_BUFFER_SIZE

See Also:

• Constant Field Values

DEFAULT_SUGGESTIONS_MIN_BUFFER_SIZE

public static final int DEFAULT_SUGGESTIONS_MIN_BUFFER_SIZE

See Also:

• Constant Field Values

DEFAULT_SYSTEM_PROPERTY_PREFIX

public static final String DEFAULT_SYSTEM_PROPERTY_PREFIX

See Also:

• Constant Field Values

BRACKETED_PASTE_ON

public static final String BRACKETED_PASTE_ON

See Also:

• Constant Field Values

BRACKETED_PASTE_OFF

public static final String BRACKETED_PASTE_OFF

See Also:

• Constant Field Values

BRACKETED_PASTE_BEGIN

public static final String BRACKETED_PASTE_BEGIN

See Also:

• Constant Field Values

BRACKETED_PASTE_END

public static final String BRACKETED_PASTE_END

See Also:

• Constant Field Values

FOCUS_IN_SEQ

public static final String FOCUS_IN_SEQ

See Also:

• Constant Field Values

FOCUS_OUT_SEQ

public static final String FOCUS_OUT_SEQ

See Also:

• Constant Field Values

DEFAULT_MAX_REPEAT_COUNT

public static final int DEFAULT_MAX_REPEAT_COUNT

See Also:

• Constant Field Values

terminal

protected final org.jline.terminal.Terminal terminal

The terminal to use

appName

protected final String appName

The application name

keyMaps

protected final Map<String,KeyMap<Binding>> keyMaps

The terminal keys mapping

variables

protected final Map<String,Object> variables

history

protected History history

completer

protected Completer completer

highlighter

protected Highlighter highlighter

parser

protected Parser parser

expander

protected Expander expander

completionMatcher

protected CompletionMatcher completionMatcher

options

protected final Map<LineReader.Option,Boolean> options

maskThread

protected Thread maskThread

buf

protected final Buffer buf

tailTip

protected String tailTip

autosuggestion

protected LineReader.SuggestionType autosuggestion

size

protected final org.jline.terminal.Size size

prompt

protected org.jline.utils.AttributedString prompt

rightPrompt

protected org.jline.utils.AttributedString rightPrompt

maskingCallback

protected MaskingCallback maskingCallback

modifiedHistory

protected Map<Integer,String> modifiedHistory

historyBuffer

protected Buffer historyBuffer

searchBuffer

protected CharSequence searchBuffer

searchTerm

protected StringBuffer searchTerm

searchFailing

protected boolean searchFailing

searchBackward

protected boolean searchBackward

searchIndex

protected int searchIndex

doAutosuggestion

protected boolean doAutosuggestion

bindingReader

protected final BindingReader bindingReader

findChar

protected int findChar

VI character find

findDir

protected int findDir

findTailAdd

protected int findTailAdd

regionMark

protected int regionMark

Region state

regionActive

protected LineReader.RegionType regionActive

yankBuffer

protected String yankBuffer

The vi yank buffer

viMoveMode

protected LineReaderImpl.ViMoveMode viMoveMode

killRing

protected KillRing killRing

undo

protected UndoTree<Buffer> undo

isUndo

protected boolean isUndo

lock

protected final ReentrantLock lock

State lock

state

protected LineReaderImpl.State state

startedReading

protected final AtomicBoolean startedReading

reading

protected boolean reading

post

protected Supplier<org.jline.utils.AttributedString> post

builtinWidgets

protected Map<String,Widget> builtinWidgets

widgets

protected Map<String,Widget> widgets

count

protected int count

mult

protected int mult

universal

protected int universal

repeatCount

protected int repeatCount

isArgDigit

protected boolean isArgDigit

parsedLine

protected ParsedLine parsedLine

skipRedisplay

protected boolean skipRedisplay

display

protected org.jline.utils.Display display

lastStatusSize

protected int lastStatusSize

overTyping

protected boolean overTyping

keyMap

protected String keyMap

smallTerminalOffset

protected int smallTerminalOffset

nextCommandFromHistory

protected boolean nextCommandFromHistory

nextHistoryId

protected int nextHistoryId

commandsBuffer

protected List<String> commandsBuffer

candidateStartPosition

protected int candidateStartPosition

alternateIn

protected String alternateIn

alternateOut

protected String alternateOut

currentLine

protected int currentLine

Constructor Details

LineReaderImpl

public LineReaderImpl(org.jline.terminal.Terminal terminal)
               throws IOException

Throws:

IOException

LineReaderImpl

public LineReaderImpl(org.jline.terminal.Terminal terminal,
 String appName)
               throws IOException

Throws:

IOException

LineReaderImpl

public LineReaderImpl(org.jline.terminal.Terminal terminal,
 String appName,
 Map<String,Object> variables)

Method Details

getTerminal

public org.jline.terminal.Terminal getTerminal()

Description copied from interface: LineReader

Returns the terminal associated with this LineReader.

The terminal is used for input/output operations and provides information about the terminal capabilities and size.

Specified by:

getTerminal in interface LineReader

Returns:

the terminal

getAppName

public String getAppName()

Description copied from interface: LineReader

Returns the application name associated with this LineReader.

The application name is used for various purposes, such as naming history files and identifying the application in terminal titles.

Specified by:

getAppName in interface LineReader

Returns:

the application name

getKeyMaps

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

Description copied from interface: LineReader

Returns all key maps registered with this LineReader.

Key maps define the mappings from key sequences to actions for different editing modes (e.g., Emacs mode, Vi command mode, Vi insert mode).

Specified by:

getKeyMaps in interface LineReader

Returns:

a map of key map names to key maps

getKeys

public KeyMap<Binding> getKeys()

Description copied from interface: LineReader

Returns the currently active key map.

The active key map determines how key presses are interpreted and which actions they trigger.

Specified by:

getKeys in interface LineReader

Returns:

the active key map

getWidgets

public Map<String,Widget> getWidgets()

Description copied from interface: LineReader

Returns a map of all widgets registered with this LineReader.

Widgets are functions that perform editing operations and can be bound to key sequences.

Specified by:

getWidgets in interface LineReader

Returns:

a map of widget names to widgets

getBuiltinWidgets

public Map<String,Widget> getBuiltinWidgets()

Description copied from interface: LineReader

Returns a map of all built-in widgets provided by the LineReader.

Built-in widgets implement standard editing operations like cursor movement, text deletion, history navigation, etc.

Specified by:

getBuiltinWidgets in interface LineReader

Returns:

a map of built-in widget names to widgets

getBuffer

public Buffer getBuffer()

Description copied from interface: LineReader

Returns the current line buffer.

The buffer contains the text that the user is currently editing. It provides methods for manipulating the text and cursor position.

Specified by:

getBuffer in interface LineReader

Returns:

the current line buffer

setAutosuggestion

public void setAutosuggestion(LineReader.SuggestionType type)

Description copied from interface: LineReader

Sets the type of auto-suggestion to use.

Auto-suggestions provide inline completion suggestions as the user types, based on history, completers, or other sources.

Specified by:

setAutosuggestion in interface LineReader

Parameters:

type - the type of auto-suggestion to use

getAutosuggestion

public LineReader.SuggestionType getAutosuggestion()

Description copied from interface: LineReader

Returns the current auto-suggestion type.

Auto-suggestions provide inline completion suggestions as the user types, based on history, completers, or other sources.

Specified by:

getAutosuggestion in interface LineReader

Returns:

the current auto-suggestion type

getTailTip

public String getTailTip()

Description copied from interface: LineReader

Returns the current tail tip text.

The tail tip is a hint or suggestion displayed at the end of the current line, typically showing command syntax or parameter information.

Specified by:

getTailTip in interface LineReader

Returns:

the current tail tip text, or null if no tail tip is set

setTailTip

public void setTailTip(String tailTip)

Description copied from interface: LineReader

Sets the tail tip text.

The tail tip is a hint or suggestion displayed at the end of the current line, typically showing command syntax or parameter information.

Specified by:

setTailTip in interface LineReader

Parameters:

tailTip - the tail tip text to display, or null to clear the tail tip

runMacro

public void runMacro(String macro)

Description copied from interface: LineReader

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

Specified by:

runMacro in interface LineReader

Parameters:

macro - the key sequence to push back

See Also:

• Terminal.getCursorPosition(IntConsumer)
• LineReader.readMouseEvent()

readMouseEvent

public org.jline.terminal.MouseEvent readMouseEvent()

Description copied from interface: LineReader

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

Specified by:

readMouseEvent in interface LineReader

Returns:

the mouse event

See Also:

• LineReader.runMacro(String)
• Terminal.getCursorPosition(IntConsumer)

setCompleter

public void setCompleter(Completer completer)

Set the completer.

Parameters:

completer - the completer to use

getCompleter

public Completer getCompleter()

Returns the completer.

Returns:

the completer

setHistory

public void setHistory(History history)

getHistory

public History getHistory()

Description copied from interface: LineReader

Returns the history associated with this LineReader.

The history stores previously entered command lines and provides methods for navigating, searching, and managing history entries.

Specified by:

getHistory in interface LineReader

Returns:

the command history

setHighlighter

public void setHighlighter(Highlighter highlighter)

getHighlighter

public Highlighter getHighlighter()

Description copied from interface: LineReader

Returns the highlighter associated with this LineReader.

The highlighter is responsible for applying syntax highlighting to the command line as the user types.

Specified by:

getHighlighter in interface LineReader

Returns:

the highlighter

getParser

public Parser getParser()

Description copied from interface: LineReader

Returns the parser associated with this LineReader.

The parser is responsible for breaking command lines into tokens according to the syntax rules of the shell or application.

Specified by:

getParser in interface LineReader

Returns:

the parser

setParser

public void setParser(Parser parser)

getExpander

public Expander getExpander()

Description copied from interface: LineReader

Returns the expander associated with this LineReader.

The expander is responsible for expanding special syntax in the command line, such as history references (e.g., !!, !$) and variables (e.g., $HOME).

Specified by:

getExpander in interface LineReader

Returns:

the expander

setExpander

public void setExpander(Expander expander)

setCompletionMatcher

public void setCompletionMatcher(CompletionMatcher completionMatcher)

readLine

public String readLine()
                throws UserInterruptException,
EndOfFileException

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

Specified by:

readLine in interface LineReader

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)

readLine

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

Specified by:

readLine in interface LineReader

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)

readLine

public String readLine(String prompt)
                throws UserInterruptException,
EndOfFileException

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

Specified by:

readLine in interface LineReader

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)

readLine

public String readLine(String prompt,
 Character mask)
                throws UserInterruptException,
EndOfFileException

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

Specified by:

readLine in interface LineReader

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)

readLine

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

Specified by:

readLine in interface LineReader

Parameters:

prompt - The prompt to issue to the terminal, may be null.

mask - The mask character, null or 0.

buffer - A string that will be set for editing.

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)

readLine

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

Specified by:

readLine in interface LineReader

Parameters:

prompt - The prompt to issue to the terminal, may be null.

rightPrompt - The prompt to issue to the right of the terminal, may be null.

mask - The mask character, null or 0.

buffer - A string that will be set for editing.

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)

readLine

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

Specified by:

readLine in interface LineReader

Parameters:

prompt - The prompt to issue to the terminal, may be null.

rightPrompt - The prompt to issue to the right of the terminal, may be null.

maskingCallback - The callback used to mask parts of the edited line.

buffer - A string that will be set for editing.

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)

printAbove

public void printAbove(String str)

Description copied from interface: LineReader

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.

Specified by:

printAbove in interface LineReader

Parameters:

str - the string to print

See Also:

• LineReader.printAbove(AttributedString)

printAbove

public void printAbove(org.jline.utils.AttributedString str)

Description copied from interface: LineReader

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.

Specified by:

printAbove in interface LineReader

Parameters:

str - the string to print

See Also:

• LineReader.printAbove(String)

isReading

public boolean isReading()

Description copied from interface: LineReader

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

Specified by:

isReading in interface LineReader

Returns:

true if there is an ongoing readLine() call.

freshLine

protected boolean freshLine()

callWidget

public void callWidget(String name)

Description copied from interface: LineReader

Calls a widget by name.

Widgets are functions that perform editing operations. This method allows invoking a widget programmatically rather than through a key binding.

Specified by:

callWidget in interface LineReader

Parameters:

name - the name of the widget to call

redrawLine

public boolean redrawLine()

Clear the line and redraw it.

Returns:

true

putString

public void putString(CharSequence str)

Write out the specified string to the buffer and the output stream.

Parameters:

str - the char sequence to write in the buffer

flush

public void flush()

Flush the terminal output stream. This is important for printout out single characters (like a buf.backspace or keyboard) that we want the terminal to handle immediately.

Specified by:

flush in interface Flushable

isKeyMap

public boolean isKeyMap(String name)

readCharacter

public int readCharacter()

Read a character from the terminal.

Returns:

the character, or -1 if an EOF is received.

peekCharacter

public int peekCharacter(long timeout)

doReadBinding

protected <T> T doReadBinding(KeyMap<T> keys,
 KeyMap<T> local)

doReadStringUntil

protected String doReadStringUntil(String sequence)

readBinding

public Binding readBinding(KeyMap<Binding> keys)

Read from the input stream and decode an operation from the key map. The input stream will be read character by character until a matching binding can be found. Characters that can't possibly be matched to any binding will be discarded.

Parameters:

keys - the KeyMap to use for decoding the input stream

Returns:

the decoded binding or null if the end of stream has been reached

readBinding

public Binding readBinding(KeyMap<Binding> keys,
 KeyMap<Binding> local)

getParsedLine

public ParsedLine getParsedLine()

Description copied from interface: LineReader

Returns the parsed representation of the current line.

The parsed line contains the tokenized form of the current input line, broken down according to the syntax rules of the parser.

Specified by:

getParsedLine in interface LineReader

Returns:

the parsed line, or null if the line has not been parsed yet

getLastBinding

public String getLastBinding()

Description copied from interface: LineReader

Returns the last key binding that was processed.

This is the string representation of the last key sequence that triggered an action.

Specified by:

getLastBinding in interface LineReader

Returns:

the last key binding, or null if no binding has been processed

getSearchTerm

public String getSearchTerm()

Description copied from interface: LineReader

Returns the current search term when in history search mode.

This is the string that the user is searching for in the command history.

Specified by:

getSearchTerm in interface LineReader

Returns:

the current search term, or null if not in search mode

getRegionActive

public LineReader.RegionType getRegionActive()

Description copied from interface: LineReader

Returns the type of the currently active region selection.

The region is a selected portion of text in the buffer, similar to a selection in a text editor.

Specified by:

getRegionActive in interface LineReader

Returns:

the type of the active region, or LineReader.RegionType.NONE if no region is active

getRegionMark

public int getRegionMark()

Description copied from interface: LineReader

Returns the mark position of the currently active region.

The mark is one endpoint of the selected region, with the cursor being the other endpoint.

Specified by:

getRegionMark in interface LineReader

Returns:

the position of the mark, or -1 if no region is active

setKeyMap

public boolean setKeyMap(String name)

Sets the current keymap by name. Supported keymaps are "emacs", "viins", "vicmd".

Specified by:

setKeyMap in interface LineReader

Parameters:

name - The name of the keymap to switch to

Returns:

true if the keymap was set, or false if the keymap is not recognized.

getKeyMap

public String getKeyMap()

Returns the name of the current key mapping.

Specified by:

getKeyMap in interface LineReader

Returns:

the name of the key mapping. This will be the canonical name of the current mode of the key map and may not reflect the name that was used with setKeyMap(String).

variable

public LineReader variable(String name,
 Object value)

Description copied from interface: LineReader

Sets a variable in the LineReader and returns the LineReader for method chaining.

Variables control various aspects of the LineReader's behavior. See the various variable constants defined in this interface for available options.

Specified by:

variable in interface LineReader

Parameters:

name - the variable name

value - the variable value

Returns:

this LineReader

getVariables

public Map<String,Object> getVariables()

Description copied from interface: LineReader

Returns a map of all variables set in the LineReader.

Variables control various aspects of the LineReader's behavior. See the various variable constants defined in this interface for available options.

Specified by:

getVariables in interface LineReader

Returns:

a map of variable names to their values

getVariable

public Object getVariable(String name)

Description copied from interface: LineReader

Returns the value of a variable.

Variables control various aspects of the LineReader's behavior. See the various variable constants defined in this interface for available options.

Specified by:

getVariable in interface LineReader

Parameters:

name - the variable name

Returns:

the variable value, or null if the variable is not set

setVariable

public void setVariable(String name,
 Object value)

Description copied from interface: LineReader

Sets a variable in the LineReader.

Variables control various aspects of the LineReader's behavior. See the various variable constants defined in this interface for available options.

Specified by:

setVariable in interface LineReader

Parameters:

name - the variable name

value - the variable value

option

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

Description copied from interface: LineReader

Sets an option in the LineReader and returns the LineReader for method chaining.

Options control various aspects of the LineReader's behavior. See the LineReader.Option enum for available options.

Specified by:

option in interface LineReader

Parameters:

option - the option to set

value - the option value

Returns:

this LineReader

isSet

public boolean isSet(LineReader.Option option)

Description copied from interface: LineReader

Checks if an option is set.

Options control various aspects of the LineReader's behavior. See the LineReader.Option enum for available options.

Specified by:

isSet in interface LineReader

Parameters:

option - the option to check

Returns:

true if the option is set, false otherwise

setOpt

public void setOpt(LineReader.Option option)

Description copied from interface: LineReader

Sets an option to true.

Options control various aspects of the LineReader's behavior. See the LineReader.Option enum for available options.

Specified by:

setOpt in interface LineReader

Parameters:

option - the option to set

unsetOpt

public void unsetOpt(LineReader.Option option)

Description copied from interface: LineReader

Sets an option to false.

Options control various aspects of the LineReader's behavior. See the LineReader.Option enum for available options.

Specified by:

unsetOpt in interface LineReader

Parameters:

option - the option to unset

addCommandsInBuffer

public void addCommandsInBuffer(Collection<String> commands)

Description copied from interface: LineReader

Adds a collection of commands to the input buffer for execution.

These commands will be executed one by one when the user accepts the current line. This is useful for implementing features like command scripts or macros.

Specified by:

addCommandsInBuffer in interface LineReader

Parameters:

commands - the commands to add to the buffer

editAndAddInBuffer

public void editAndAddInBuffer(Path file)
                        throws Exception

Description copied from interface: LineReader

Opens a file in an external editor and adds its contents to the input buffer.

This method allows the user to edit a file in their preferred text editor and then have its contents added to the input buffer for execution.

Specified by:

editAndAddInBuffer in interface LineReader

Parameters:

file - the file to edit, or null to create a temporary file

Throws:

Exception - if an error occurs while editing the file

getTabWidth

protected int getTabWidth()

finishBuffer

protected String finishBuffer()

Clear the buffer and add its contents to the history.

Returns:

the former contents of the buffer.

finish

protected String finish(String str)

handleSignal

protected void handleSignal(org.jline.terminal.Terminal.Signal signal)

getWidget

protected Widget getWidget(Object binding)

setPrompt

public void setPrompt(String prompt)

setRightPrompt

public void setRightPrompt(String rightPrompt)

setBuffer

protected void setBuffer(Buffer buffer)

setBuffer

protected void setBuffer(String buffer)

Set the current buffer's content to the specified String. The visual terminal will be modified to show the current buffer.

Parameters:

buffer - the new contents of the buffer.

viDeleteChangeYankToRemap

protected String viDeleteChangeYankToRemap(String op)

This method is calling while doing a delete-to ("d"), change-to ("c"), or yank-to ("y") and it filters out only those movement operations that are allowable during those operations. Any operation that isn't allow drops you back into movement mode.

Parameters:

op - The incoming operation to remap

Returns:

The remaped operation

switchCase

protected int switchCase(int ch)

isInViMoveOperation

protected boolean isInViMoveOperation()

Returns:

true if line reader is in the middle of doing a change-to delete-to or yank-to.

isInViChangeOperation

protected boolean isInViChangeOperation()

isInViCmdMode

protected boolean isInViCmdMode()

viForwardChar

protected boolean viForwardChar()

viBackwardChar

protected boolean viBackwardChar()

forwardWord

protected boolean forwardWord()

viForwardWord

protected boolean viForwardWord()

viForwardBlankWord

protected boolean viForwardBlankWord()

emacsForwardWord

protected boolean emacsForwardWord()

viForwardBlankWordEnd

protected boolean viForwardBlankWordEnd()

viForwardWordEnd

protected boolean viForwardWordEnd()

backwardWord

protected boolean backwardWord()

viBackwardWord

protected boolean viBackwardWord()

viBackwardBlankWord

protected boolean viBackwardBlankWord()

viBackwardWordEnd

protected boolean viBackwardWordEnd()

viBackwardBlankWordEnd

protected boolean viBackwardBlankWordEnd()

emacsBackwardWord

protected boolean emacsBackwardWord()

backwardDeleteWord

protected boolean backwardDeleteWord()

viBackwardKillWord

protected boolean viBackwardKillWord()

backwardKillWord

protected boolean backwardKillWord()

copyPrevWord

protected boolean copyPrevWord()

upCaseWord

protected boolean upCaseWord()

downCaseWord

protected boolean downCaseWord()

capitalizeWord

protected boolean capitalizeWord()

deleteWord

protected boolean deleteWord()

killWord

protected boolean killWord()

transposeWords

protected boolean transposeWords()

insertComment

protected boolean insertComment()

viInsertComment

protected boolean viInsertComment()

doInsertComment

protected boolean doInsertComment(boolean isViMode)

viFindNextChar

protected boolean viFindNextChar()

viFindPrevChar

protected boolean viFindPrevChar()

viFindNextCharSkip

protected boolean viFindNextCharSkip()

viFindPrevCharSkip

protected boolean viFindPrevCharSkip()

viRepeatFind

protected boolean viRepeatFind()

viRevRepeatFind

protected boolean viRevRepeatFind()

viHistorySearchForward

protected boolean viHistorySearchForward()

Implements vi search ("/" or "?").

Returns:

true if the search was successful

viHistorySearchBackward

protected boolean viHistorySearchBackward()

viRepeatSearch

protected boolean viRepeatSearch()

viRevRepeatSearch

protected boolean viRevRepeatSearch()

insertCloseCurly

protected boolean insertCloseCurly()

insertCloseParen

protected boolean insertCloseParen()

insertCloseSquare

protected boolean insertCloseSquare()

insertClose

protected boolean insertClose(String s)

viMatchBracket

protected boolean viMatchBracket()

undefinedKey

protected boolean undefinedKey()

doViMatchBracket

protected boolean doViMatchBracket()

Implements vi style bracket matching ("%" command). The matching bracket for the current bracket type that you are sitting on is matched.

Returns:

true if it worked, false if the cursor was not on a bracket character or if there was no matching bracket.

getBracketType

protected int getBracketType(int ch)

Given a character determines what type of bracket it is (paren, square, curly, or none).

Parameters:

ch - The character to check

Returns:

1 is square, 2 curly, 3 parent, or zero for none. The value will be negated if it is the closing form of the bracket.

transposeChars

protected boolean transposeChars()

Performs character transpose. The character prior to the cursor and the character under the cursor are swapped and the cursor is advanced one. Do not cross line breaks.

Returns:

true

undo

protected boolean undo()

redo

protected boolean redo()

sendBreak

protected boolean sendBreak()

backwardChar

protected boolean backwardChar()

forwardChar

protected boolean forwardChar()

viDigitOrBeginningOfLine

protected boolean viDigitOrBeginningOfLine()

universalArgument

protected boolean universalArgument()

argumentBase

protected boolean argumentBase()

negArgument

protected boolean negArgument()

digitArgument

protected boolean digitArgument()

viDelete

protected boolean viDelete()

viYankTo

protected boolean viYankTo()

viYankWholeLine

protected boolean viYankWholeLine()

viChange

protected boolean viChange()

cleanup

protected void cleanup()

doCleanup

protected void doCleanup(boolean nl)

historyIncrementalSearchForward

protected boolean historyIncrementalSearchForward()

historyIncrementalSearchBackward

protected boolean historyIncrementalSearchBackward()

doSearchHistory

protected boolean doSearchHistory(boolean backward)

historySearchForward

protected boolean historySearchForward()

historySearchBackward

protected boolean historySearchBackward()

searchBackwards

public int searchBackwards(String searchTerm,
 int startIndex)

Search backward in history from a given position.

Parameters:

searchTerm - substring to search for.

startIndex - the index from which on to search

Returns:

index where this substring has been found, or -1 else.

searchBackwards

public int searchBackwards(String searchTerm)

Search backwards in history from the current position.

Parameters:

searchTerm - substring to search for.

Returns:

index where the substring has been found, or -1 else.

searchBackwards

public int searchBackwards(String searchTerm,
 int startIndex,
 boolean startsWith)

searchForwards

public int searchForwards(String searchTerm,
 int startIndex,
 boolean startsWith)

searchForwards

public int searchForwards(String searchTerm,
 int startIndex)

Search forward in history from a given position.

Parameters:

searchTerm - substring to search for.

startIndex - the index from which on to search

Returns:

index where this substring has been found, or -1 else.

searchForwards

public int searchForwards(String searchTerm)

Search forwards in history from the current position.

Parameters:

searchTerm - substring to search for.

Returns:

index where the substring has been found, or -1 else.

quit

protected boolean quit()

acceptAndHold

protected boolean acceptAndHold()

acceptLineAndDownHistory

protected boolean acceptLineAndDownHistory()

acceptAndInferNextHistory

protected boolean acceptAndInferNextHistory()

acceptLine

protected boolean acceptLine()

selfInsert

protected boolean selfInsert()

selfInsertUnmeta

protected boolean selfInsertUnmeta()

overwriteMode

protected boolean overwriteMode()

beginningOfBufferOrHistory

protected boolean beginningOfBufferOrHistory()

beginningOfHistory

protected boolean beginningOfHistory()

endOfBufferOrHistory

protected boolean endOfBufferOrHistory()

endOfHistory

protected boolean endOfHistory()

beginningOfLineHist

protected boolean beginningOfLineHist()

endOfLineHist

protected boolean endOfLineHist()

upHistory

protected boolean upHistory()

downHistory

protected boolean downHistory()

viUpLineOrHistory

protected boolean viUpLineOrHistory()

viDownLineOrHistory

protected boolean viDownLineOrHistory()

upLine

protected boolean upLine()

downLine

protected boolean downLine()

upLineOrHistory

protected boolean upLineOrHistory()

upLineOrSearch

protected boolean upLineOrSearch()

downLineOrHistory

protected boolean downLineOrHistory()

downLineOrSearch

protected boolean downLineOrSearch()

viCmdMode

protected boolean viCmdMode()

viInsert

protected boolean viInsert()

viAddNext

protected boolean viAddNext()

viAddEol

protected boolean viAddEol()

emacsEditingMode

protected boolean emacsEditingMode()

viChangeWholeLine

protected boolean viChangeWholeLine()

viChangeEol

protected boolean viChangeEol()

viKillEol

protected boolean viKillEol()

quotedInsert

protected boolean quotedInsert()

viJoin

protected boolean viJoin()

viKillWholeLine

protected boolean viKillWholeLine()

viInsertBol

protected boolean viInsertBol()

backwardDeleteChar

protected boolean backwardDeleteChar()

viFirstNonBlank

protected boolean viFirstNonBlank()

viBeginningOfLine

protected boolean viBeginningOfLine()

viEndOfLine

protected boolean viEndOfLine()

beginningOfLine

protected boolean beginningOfLine()

endOfLine

protected boolean endOfLine()

deleteChar

protected boolean deleteChar()

viBackwardDeleteChar

protected boolean viBackwardDeleteChar()

Deletes the previous character from the cursor position

Returns:

true if it succeeded, false otherwise

viDeleteChar

protected boolean viDeleteChar()

Deletes the character you are sitting on and sucks the rest of the line in from the right.

Returns:

true if it succeeded, false otherwise

viSwapCase

protected boolean viSwapCase()

Switches the case of the current character from upper to lower or lower to upper as necessary and advances the cursor one position to the right.

Returns:

true if it succeeded, false otherwise

viReplaceChars

protected boolean viReplaceChars()

Implements the vi change character command (in move-mode "r" followed by the character to change to).

Returns:

true if it succeeded, false otherwise

viChange

protected boolean viChange(int startPos,
 int endPos)

viDeleteTo

protected boolean viDeleteTo(int startPos,
 int endPos)

doViDeleteOrChange

protected boolean doViDeleteOrChange(int startPos,
 int endPos,
 boolean isChange)

Performs the vi "delete-to" action, deleting characters between a given span of the input line.

Parameters:

startPos - The start position

endPos - The end position.

isChange - If true, then the delete is part of a change operationg (e.g. "c$" is change-to-end-of line, so we first must delete to end of line to start the change

Returns:

true if it succeeded, false otherwise

viYankTo

protected boolean viYankTo(int startPos,
 int endPos)

Implement the "vi" yank-to operation. This operation allows you to yank the contents of the current line based upon a move operation, for example "yw" yanks the current word, "3yw" yanks 3 words, etc.

Parameters:

startPos - The starting position from which to yank

endPos - The ending position to which to yank

Returns:

true if the yank succeeded

viOpenLineAbove

protected boolean viOpenLineAbove()

viOpenLineBelow

protected boolean viOpenLineBelow()

viPutAfter

protected boolean viPutAfter()

Pasts the yank buffer to the right of the current cursor position and moves the cursor to the end of the pasted region.

Returns:

true

viPutBefore

protected boolean viPutBefore()

doLowercaseVersion

protected boolean doLowercaseVersion()

setMarkCommand

protected boolean setMarkCommand()

exchangePointAndMark

protected boolean exchangePointAndMark()

visualMode

protected boolean visualMode()

visualLineMode

protected boolean visualLineMode()

deactivateRegion

protected boolean deactivateRegion()

whatCursorPosition

protected boolean whatCursorPosition()

editAndExecute

protected boolean editAndExecute()

builtinWidgets

protected Map<String,Widget> builtinWidgets()

redisplay

public boolean redisplay()

redisplay

protected void redisplay(boolean flush)

getDisplayedBufferWithPrompts

public org.jline.utils.AttributedString getDisplayedBufferWithPrompts(List<org.jline.utils.AttributedString> secondaryPrompts)

Compute the full string to be displayed with the left, right and secondary prompts

Parameters:

secondaryPrompts - a list to store the secondary prompts

Returns:

the displayed string including the buffer, left prompts and the help below

insertTab

protected boolean insertTab()

expandHistory

protected boolean expandHistory()

expandWord

protected boolean expandWord()

expandOrComplete

protected boolean expandOrComplete()

expandOrCompletePrefix

protected boolean expandOrCompletePrefix()

completeWord

protected boolean completeWord()

menuComplete

protected boolean menuComplete()

menuExpandOrComplete

protected boolean menuExpandOrComplete()

completePrefix

protected boolean completePrefix()

listChoices

protected boolean listChoices()

deleteCharOrList

protected boolean deleteCharOrList()

doComplete

protected boolean doComplete(LineReaderImpl.CompletionType lst,
 boolean useMenu,
 boolean prefix)

doComplete

protected boolean doComplete(LineReaderImpl.CompletionType lst,
 boolean useMenu,
 boolean prefix,
 boolean forSuggestion)

wrap

protected static CompletingParsedLine wrap(ParsedLine line)

getCandidateComparator

protected Comparator<Candidate> getCandidateComparator(boolean caseInsensitive,
 String word)

getOthersGroupName

protected String getOthersGroupName()

getOriginalGroupName

protected String getOriginalGroupName()

getGroupComparator

protected Comparator<String> getGroupComparator()

nextBindingIsComplete

protected boolean nextBindingIsComplete()

doMenu

protected boolean doMenu(List<Candidate> original,
 String completed,
 BiFunction<CharSequence,Boolean,CharSequence> escaper)

clearChoices

protected boolean clearChoices()

doList

protected boolean doList(List<Candidate> possible,
 String completed,
 boolean runLoop,
 BiFunction<CharSequence,Boolean,CharSequence> escaper)

doList

protected boolean doList(List<Candidate> possible,
 String completed,
 boolean runLoop,
 BiFunction<CharSequence,Boolean,CharSequence> escaper,
 boolean forSuggestion)

computePost

protected LineReaderImpl.PostResult computePost(List<Candidate> possible,
 Candidate selection,
 List<Candidate> ordered,
 String completed)

computePost

protected LineReaderImpl.PostResult computePost(List<Candidate> possible,
 Candidate selection,
 List<Candidate> ordered,
 String completed,
 Function<String,Integer> wcwidth,
 int width,
 boolean autoGroup,
 boolean groupName,
 boolean rowsFirst)

toColumns

protected LineReaderImpl.PostResult toColumns(List<Object> items,
 Candidate selection,
 String completed,
 Function<String,Integer> wcwidth,
 int width,
 boolean rowsFirst)

toColumns

protected void toColumns(Object items,
 int width,
 int maxWidth,
 org.jline.utils.AttributedStringBuilder sb,
 Candidate selection,
 String completed,
 boolean rowsFirst,
 boolean doMenuList,
 int[] out)

getCompletionStyleStarting

protected org.jline.utils.AttributedStyle getCompletionStyleStarting(boolean menuList)

getCompletionStyleDescription

protected org.jline.utils.AttributedStyle getCompletionStyleDescription(boolean menuList)

getCompletionStyleGroup

protected org.jline.utils.AttributedStyle getCompletionStyleGroup(boolean menuList)

getCompletionStyleSelection

protected org.jline.utils.AttributedStyle getCompletionStyleSelection(boolean menuList)

getCompletionStyleBackground

protected org.jline.utils.AttributedStyle getCompletionStyleBackground(boolean menuList)

getCompletionStyleStarting

protected org.jline.utils.AttributedStyle getCompletionStyleStarting()

getCompletionStyleDescription

protected org.jline.utils.AttributedStyle getCompletionStyleDescription()

getCompletionStyleGroup

protected org.jline.utils.AttributedStyle getCompletionStyleGroup()

getCompletionStyleSelection

protected org.jline.utils.AttributedStyle getCompletionStyleSelection()

getCompletionStyleBackground

protected org.jline.utils.AttributedStyle getCompletionStyleBackground()

getCompletionStyleListStarting

protected org.jline.utils.AttributedStyle getCompletionStyleListStarting()

getCompletionStyleListDescription

protected org.jline.utils.AttributedStyle getCompletionStyleListDescription()

getCompletionStyleListGroup

protected org.jline.utils.AttributedStyle getCompletionStyleListGroup()

getCompletionStyleListSelection

protected org.jline.utils.AttributedStyle getCompletionStyleListSelection()

getCompletionStyleListBackground

protected org.jline.utils.AttributedStyle getCompletionStyleListBackground()

getCompletionStyle

protected org.jline.utils.AttributedStyle getCompletionStyle(String name,
 String value)

buildStyle

protected org.jline.utils.AttributedStyle buildStyle(String str)

moveHistory

protected boolean moveHistory(boolean next,
 int count)

Used in "vi" mode for argumented history move, to move a specific number of history entries forward or back.

Parameters:

next - If true, move forward

count - The number of entries to move

Returns:

true if the move was successful

moveHistory

protected boolean moveHistory(boolean next)

Move up or down the history tree.

Parameters:

next - true to go to the next, false for the previous.

Returns:

true if successful, false otherwise

killBuffer

protected boolean killBuffer()

killWholeLine

protected boolean killWholeLine()

killLine

public boolean killLine()

Kill the buffer ahead of the current cursor position.

Returns:

true if successful

backwardKillLine

public boolean backwardKillLine()

killRegion

public boolean killRegion()

copyRegionAsKill

public boolean copyRegionAsKill()

yank

public boolean yank()

yankPop

public boolean yankPop()

mouse

public boolean mouse()

beginPaste

public boolean beginPaste()

focusIn

public boolean focusIn()

focusOut

public boolean focusOut()

clear

public boolean clear()

Clean the used display

Returns:

true

clearScreen

public boolean clearScreen()

Clear the screen by issuing the ANSI "clear screen" code.

Returns:

true

beep

public boolean beep()

Issue an audible keyboard bell.

Returns:

true

isDelimiter

protected boolean isDelimiter(int c)

Checks to see if the specified character is a delimiter. We consider a character a delimiter if it is anything but a letter or digit.

Parameters:

c - The character to test

Returns:

True if it is a delimiter

isWhitespace

protected boolean isWhitespace(int c)

Checks to see if a character is a whitespace character. Currently this delegates to Character.isWhitespace(char), however eventually it should be hooked up so that the definition of whitespace can be configured, as readline does.

Parameters:

c - The character to check

Returns:

true if the character is a whitespace

isViAlphaNum

protected boolean isViAlphaNum(int c)

isAlpha

protected boolean isAlpha(int c)

isWord

protected boolean isWord(int c)

defaultKeyMaps

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

Description copied from interface: LineReader

Returns the default key maps used by the LineReader.

These key maps define the standard key bindings for different editing modes such as Emacs mode, Vi command mode, Vi insert mode, etc.

Specified by:

defaultKeyMaps in interface LineReader

Returns:

a map of key map names to key maps

emacs

public KeyMap<Binding> emacs()

viInsertion

public KeyMap<Binding> viInsertion()

viCmd

public KeyMap<Binding> viCmd()

menu

public KeyMap<Binding> menu()

safe

public KeyMap<Binding> safe()

dumb

public KeyMap<Binding> dumb()

visual

public KeyMap<Binding> visual()

viOpp

public KeyMap<Binding> viOpp()

zeroOut

public void zeroOut()

Description copied from interface: LineReader

Clears any internal buffers and sensitive data.

This method is used to ensure that sensitive information, such as passwords or other confidential data, is removed from memory when it's no longer needed. It should be called when the LineReader is no longer in use or before reading sensitive information.

Specified by:

zeroOut in interface LineReader