A B C D E F G H I K L M N O P Q R S T U V W Y Z 
All Classes All Packages

A

accept(Path) - Method in class org.jline.reader.impl.completer.FileNameCompleter
Deprecated.
 
ACCEPT_AND_HOLD - Static variable in interface org.jline.reader.LineReader
 
ACCEPT_AND_INFER_NEXT_HISTORY - Static variable in interface org.jline.reader.LineReader
 
ACCEPT_LINE - org.jline.reader.Parser.ParseContext
Try a real "final" parse.
ACCEPT_LINE - Static variable in interface org.jline.reader.LineReader
 
ACCEPT_LINE_AND_DOWN_HISTORY - Static variable in interface org.jline.reader.LineReader
 
acceptAndHold() - Method in class org.jline.reader.impl.LineReaderImpl
 
acceptAndInferNextHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
acceptLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
acceptLineAndDownHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
add(String) - Method in interface org.jline.reader.History
 
add(String) - Method in class org.jline.reader.impl.KillRing
Adds the string to the kill-ring.
add(String, List<Completer>) - Method in class org.jline.reader.impl.completer.SystemCompleter
 
add(String, Completer) - Method in class org.jline.reader.impl.completer.SystemCompleter
 
add(Instant, String) - Method in interface org.jline.reader.History
Adds a new item to the history with the specified timestamp.
add(Instant, String) - Method in class org.jline.reader.impl.history.DefaultHistory
Adds a new entry to the history.
add(List<String>, Completer) - Method in class org.jline.reader.impl.completer.SystemCompleter
 
add(SystemCompleter) - Method in class org.jline.reader.impl.completer.SystemCompleter
 
addAliases(Map<String, String>) - Method in class org.jline.reader.impl.completer.SystemCompleter
 
addBackwards(String) - Method in class org.jline.reader.impl.KillRing
Adds the string to the kill-ring product of killing backwards.
addCommandsInBuffer(Collection<String>) - Method in class org.jline.reader.impl.LineReaderImpl
 
addCommandsInBuffer(Collection<String>) - Method in interface org.jline.reader.LineReader
Adds a collection of commands to the input buffer for execution.
addHistoryLine(Path, String) - Method in class org.jline.reader.impl.history.DefaultHistory
Adds a history line to the specified history file.
addHistoryLine(Path, String, boolean) - Method in class org.jline.reader.impl.history.DefaultHistory
Adds a history line to the specified history file with an option to check for duplicates.
AggregateCompleter - Class in org.jline.reader.impl.completer
Completer which contains multiple completers and aggregates them together.
AggregateCompleter(Collection<Completer>) - Constructor for class org.jline.reader.impl.completer.AggregateCompleter
Construct an AggregateCompleter with the given completers.
AggregateCompleter(Completer...) - Constructor for class org.jline.reader.impl.completer.AggregateCompleter
Construct an AggregateCompleter with the given completers.
alt(char) - Static method in class org.jline.keymap.KeyMap
Creates an Alt+key sequence for a single character.
alt(String) - Static method in class org.jline.keymap.KeyMap
Creates an Alt+key sequence for a string.
alternateIn - Variable in class org.jline.reader.impl.LineReaderImpl
 
alternateOut - Variable in class org.jline.reader.impl.LineReaderImpl
 
AMBIGUOUS_BINDING - Static variable in interface org.jline.reader.LineReader
Timeout for ambiguous key sequences.
ANGLE - org.jline.reader.impl.DefaultParser.Bracket
 
append(Path, boolean) - Method in interface org.jline.reader.History
Append history to the file.
append(Path, boolean) - Method in class org.jline.reader.impl.history.DefaultHistory
Appends history entries to the specified file.
apply() - Method in interface org.jline.reader.Widget
Executes the action associated with this widget.
appName - Variable in class org.jline.reader.impl.LineReaderImpl
The application name
appName(String) - Method in class org.jline.reader.LineReaderBuilder
 
ARGUMENT_BASE - Static variable in interface org.jline.reader.LineReader
 
argumentBase() - Method in class org.jline.reader.impl.LineReaderImpl
 
ArgumentCompleter - Class in org.jline.reader.impl.completer
A Completer implementation that invokes a child completer using the appropriate separator argument.
ArgumentCompleter(Collection<Completer>) - Constructor for class org.jline.reader.impl.completer.ArgumentCompleter
Create a new completer.
ArgumentCompleter(Completer...) - Constructor for class org.jline.reader.impl.completer.ArgumentCompleter
Create a new completer.
ArgumentCompleter.ArgumentLine - Class in org.jline.reader.impl.completer
A simple implementation of ParsedLine for argument completion.
ArgumentLine(String, int) - Constructor for class org.jline.reader.impl.completer.ArgumentCompleter.ArgumentLine
Creates a new ArgumentLine with the specified word and cursor position.
ArgumentList(String, List<String>, int, int, int) - Constructor for class org.jline.reader.impl.DefaultParser.ArgumentList
Deprecated.
ArgumentList(String, List<String>, int, int, int, String, int, int) - Constructor for class org.jline.reader.impl.DefaultParser.ArgumentList
 
atChar(int) - Method in interface org.jline.reader.Buffer
Returns the character at the specified position in the buffer.
atChar(int) - Method in class org.jline.reader.impl.BufferImpl
 
attach(LineReader) - Method in interface org.jline.reader.History
Initialize the history for the given reader.
attach(LineReader) - Method in class org.jline.reader.impl.history.DefaultHistory
Attaches this history to a LineReader.
AUDIBLE - org.jline.reader.impl.LineReaderImpl.BellType
 
AUTO_FRESH_LINE - org.jline.reader.LineReader.Option
if set and not at start of line before prompt, move to new line
AUTO_GROUP - org.jline.reader.LineReader.Option
when displaying candidates, group them by Candidate.group()
AUTO_LIST - org.jline.reader.LineReader.Option
 
AUTO_MENU - org.jline.reader.LineReader.Option
 
AUTO_MENU_LIST - org.jline.reader.LineReader.Option
list candidates below the field to be completed
AUTO_PARAM_SLASH - org.jline.reader.LineReader.Option
 
AUTO_REMOVE_SLASH - org.jline.reader.LineReader.Option
 
autosuggestion - Variable in class org.jline.reader.impl.LineReaderImpl
 

B

backspace() - Method in interface org.jline.reader.Buffer
Deletes the character before the cursor position.
backspace() - Method in class org.jline.reader.impl.BufferImpl
Issue a backspace.
backspace(int) - Method in interface org.jline.reader.Buffer
Deletes multiple characters before the cursor position.
backspace(int) - Method in class org.jline.reader.impl.BufferImpl
Issue num backspaces.
BACKWARD_CHAR - Static variable in interface org.jline.reader.LineReader
 
BACKWARD_DELETE_CHAR - Static variable in interface org.jline.reader.LineReader
 
BACKWARD_DELETE_WORD - Static variable in interface org.jline.reader.LineReader
 
BACKWARD_KILL_LINE - Static variable in interface org.jline.reader.LineReader
 
BACKWARD_KILL_WORD - Static variable in interface org.jline.reader.LineReader
 
BACKWARD_WORD - Static variable in interface org.jline.reader.LineReader
 
backwardChar() - Method in class org.jline.reader.impl.LineReaderImpl
 
backwardDeleteChar() - Method in class org.jline.reader.impl.LineReaderImpl
 
backwardDeleteWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
backwardKillLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
backwardKillWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
backwardWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
beep() - Method in class org.jline.reader.impl.LineReaderImpl
Issue an audible keyboard bell.
BEEP - Static variable in interface org.jline.reader.LineReader
 
BEGIN_PASTE - Static variable in interface org.jline.reader.LineReader
 
BEGINNING_OF_BUFFER_OR_HISTORY - Static variable in interface org.jline.reader.LineReader
 
BEGINNING_OF_HISTORY - Static variable in interface org.jline.reader.LineReader
 
BEGINNING_OF_LINE - Static variable in interface org.jline.reader.LineReader
 
BEGINNING_OF_LINE_HIST - Static variable in interface org.jline.reader.LineReader
 
beginningOfBufferOrHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
beginningOfHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
beginningOfLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
beginningOfLineHist() - Method in class org.jline.reader.impl.LineReaderImpl
 
beginPaste() - Method in class org.jline.reader.impl.LineReaderImpl
 
BELL_STYLE - Static variable in interface org.jline.reader.LineReader
 
bind(T, CharSequence) - Method in class org.jline.keymap.KeyMap
Binds a function to a key sequence.
bind(T, CharSequence...) - Method in class org.jline.keymap.KeyMap
Binds a function to multiple key sequences.
bind(T, Iterable<? extends CharSequence>) - Method in class org.jline.keymap.KeyMap
Binds a function to multiple key sequences.
BIND_TTY_SPECIAL_CHARS - Static variable in interface org.jline.reader.LineReader
 
bindIfNotBound(T, CharSequence) - Method in class org.jline.keymap.KeyMap
Binds a function to a key sequence only if the key sequence is not already bound.
Binding - Interface in org.jline.reader
Marker interface for objects that can be bound to key sequences in a KeyMap.
bindingReader - Variable in class org.jline.reader.impl.LineReaderImpl
 
BindingReader - Class in org.jline.keymap
The BindingReader transforms incoming characters into key bindings.
BindingReader(NonBlockingReader) - Constructor for class org.jline.keymap.BindingReader
Creates a new BindingReader that reads from the specified NonBlockingReader.
BLINK_MATCHING_PAREN - Static variable in interface org.jline.reader.LineReader
 
blockCommentDelims(DefaultParser.BlockCommentDelims) - Method in class org.jline.reader.impl.DefaultParser
Sets the block comment delimiters.
BlockCommentDelims(String, String) - Constructor for class org.jline.reader.impl.DefaultParser.BlockCommentDelims
 
BRACKETED_PASTE - org.jline.reader.LineReader.Option
 
BRACKETED_PASTE_BEGIN - Static variable in class org.jline.reader.impl.LineReaderImpl
 
BRACKETED_PASTE_END - Static variable in class org.jline.reader.impl.LineReaderImpl
 
BRACKETED_PASTE_OFF - Static variable in class org.jline.reader.impl.LineReaderImpl
 
BRACKETED_PASTE_ON - Static variable in class org.jline.reader.impl.LineReaderImpl
 
buf - Variable in class org.jline.reader.impl.LineReaderImpl
 
Buffer - Interface in org.jline.reader
Represents the editable text buffer in the LineReader.
BufferImpl - Class in org.jline.reader.impl
Default implementation of the Buffer interface.
BufferImpl() - Constructor for class org.jline.reader.impl.BufferImpl
Creates a new buffer with the default size (64).
BufferImpl(int) - Constructor for class org.jline.reader.impl.BufferImpl
Creates a new buffer with the specified size.
build() - Method in class org.jline.reader.LineReaderBuilder
Builds and returns a LineReader instance with the configured options.
builder() - Static method in class org.jline.reader.LineReaderBuilder
Creates a new LineReaderBuilder instance.
buildStyle(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
builtinWidgets - Variable in class org.jline.reader.impl.LineReaderImpl
 
builtinWidgets() - Method in class org.jline.reader.impl.LineReaderImpl
 

C

CALLBACK_FINISH - Static variable in interface org.jline.reader.LineReader
 
CALLBACK_INIT - Static variable in interface org.jline.reader.LineReader
 
CALLBACK_KEYMAP - Static variable in interface org.jline.reader.LineReader
 
callWidget(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
callWidget(String) - Method in interface org.jline.reader.LineReader
Calls a widget by name.
camelMatch(String, int, String, int) - Method in class org.jline.reader.impl.CompletionMatcherImpl
 
Candidate - Class in org.jline.reader
Represents a completion candidate for tab completion.
Candidate(String) - Constructor for class org.jline.reader.Candidate
Simple constructor with only a single String as an argument.
Candidate(String, String, String, String, String, String, boolean) - Constructor for class org.jline.reader.Candidate
Constructs a new Candidate.
Candidate(String, String, String, String, String, String, boolean, int) - Constructor for class org.jline.reader.Candidate
Constructs a new Candidate.
candidates - Variable in class org.jline.reader.impl.completer.StringsCompleter
 
candidateStartPosition - Variable in class org.jline.reader.impl.LineReaderImpl
 
canRedo() - Method in class org.jline.reader.impl.UndoTree
 
canUndo() - Method in class org.jline.reader.impl.UndoTree
 
CAPITALIZE_WORD - Static variable in interface org.jline.reader.LineReader
 
capitalizeWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
CASE_INSENSITIVE - org.jline.reader.LineReader.Option
if completion is case insensitive or not
CASE_INSENSITIVE_SEARCH - org.jline.reader.LineReader.Option
if history search is fully case insensitive
CHANGE - org.jline.reader.impl.LineReaderImpl.ViMoveMode
 
CHAR - org.jline.reader.LineReader.RegionType
 
CHARACTER_SEARCH - Static variable in interface org.jline.reader.LineReader
 
CHARACTER_SEARCH_BACKWARD - Static variable in interface org.jline.reader.LineReader
 
cleanup() - Method in class org.jline.reader.impl.LineReaderImpl
 
clear() - Method in interface org.jline.reader.Buffer
Clears the buffer content.
clear() - Method in class org.jline.reader.impl.BufferImpl
 
clear() - Method in class org.jline.reader.impl.LineReaderImpl
Clean the used display
clear() - Method in class org.jline.reader.impl.UndoTree
 
CLEAR - Static variable in interface org.jline.reader.LineReader
 
CLEAR_SCREEN - Static variable in interface org.jline.reader.LineReader
 
clearChoices() - Method in class org.jline.reader.impl.LineReaderImpl
 
clearScreen() - Method in class org.jline.reader.impl.LineReaderImpl
Clear the screen by issuing the ANSI "clear screen" code.
column() - Method in exception org.jline.reader.SyntaxError
Returns the column position where the syntax error occurred.
commandGroup(int) - Method in class org.jline.reader.impl.DefaultParser
Sets the command group for the regular expression.
commandsBuffer - Variable in class org.jline.reader.impl.LineReaderImpl
 
commandStyle(LineReader, AttributedStringBuilder, boolean) - Method in class org.jline.reader.impl.DefaultHighlighter
 
COMMENT_BEGIN - Static variable in interface org.jline.reader.LineReader
 
compareTo(Candidate) - Method in class org.jline.reader.Candidate
 
compile() - Method in class org.jline.reader.impl.completer.SystemCompleter
 
compile(Function<String, Candidate>) - Method in class org.jline.reader.impl.completer.SystemCompleter
 
compile(Map<LineReader.Option, Boolean>, boolean, CompletingParsedLine, boolean, int, String) - Method in interface org.jline.reader.CompletionMatcher
Initializes the matcher with the current completion context.
compile(Map<LineReader.Option, Boolean>, boolean, CompletingParsedLine, boolean, int, String) - Method in class org.jline.reader.impl.CompletionMatcherImpl
 
complete() - Method in class org.jline.reader.Candidate
Boolean indicating whether this candidate is complete or if the completer may further expand the candidate value after this candidate has been selected.
complete(LineReader, ParsedLine, List<Candidate>) - Method in interface org.jline.reader.Completer
Populates candidates with a list of possible completions for the command line.
complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.jline.reader.impl.completer.AggregateCompleter
Perform a completion operation across all aggregated completers.
complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.jline.reader.impl.completer.ArgumentCompleter
 
complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.jline.reader.impl.completer.FileNameCompleter
Deprecated.
 
complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.jline.reader.impl.completer.NullCompleter
 
complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.jline.reader.impl.completer.StringsCompleter
 
complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.jline.reader.impl.completer.SystemCompleter
 
Complete - org.jline.reader.impl.LineReaderImpl.CompletionType
 
COMPLETE - org.jline.reader.Parser.ParseContext
Parse to find completions (typically after a Tab).
COMPLETE_IN_WORD - org.jline.reader.LineReader.Option
 
COMPLETE_MATCHER_CAMELCASE - org.jline.reader.LineReader.Option
use camel case completion matcher
COMPLETE_MATCHER_TYPO - org.jline.reader.LineReader.Option
use type completion matcher
COMPLETE_PREFIX - Static variable in interface org.jline.reader.LineReader
 
COMPLETE_WORD - Static variable in interface org.jline.reader.LineReader
 
completePrefix() - Method in class org.jline.reader.impl.LineReaderImpl
 
completer - Variable in class org.jline.reader.impl.LineReaderImpl
 
completer(Completer) - Method in class org.jline.reader.LineReaderBuilder
Sets the completer to be used for tab completion.
Completer - Interface in org.jline.reader
A completer is the mechanism by which tab-completion candidates will be resolved.
COMPLETER - org.jline.reader.LineReader.SuggestionType
Prepare command line suggestions using command completer data.
completeWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
CompletingParsedLine - Interface in org.jline.reader
An extension of ParsedLine that, being aware of the quoting and escaping rules of the Parser that produced it, knows if and how a completion candidate should be escaped/quoted.
COMPLETION_STYLE_BACKGROUND - Static variable in interface org.jline.reader.LineReader
Completion style for displaying the list
COMPLETION_STYLE_DESCRIPTION - Static variable in interface org.jline.reader.LineReader
Completion style for displaying the candidate description
COMPLETION_STYLE_GROUP - Static variable in interface org.jline.reader.LineReader
Completion style for displaying groups name
COMPLETION_STYLE_LIST_BACKGROUND - Static variable in interface org.jline.reader.LineReader
 
COMPLETION_STYLE_LIST_DESCRIPTION - Static variable in interface org.jline.reader.LineReader
 
COMPLETION_STYLE_LIST_GROUP - Static variable in interface org.jline.reader.LineReader
 
COMPLETION_STYLE_LIST_SELECTION - Static variable in interface org.jline.reader.LineReader
 
COMPLETION_STYLE_LIST_STARTING - Static variable in interface org.jline.reader.LineReader
 
COMPLETION_STYLE_SELECTION - Static variable in interface org.jline.reader.LineReader
Completion style for displaying the current selected item
COMPLETION_STYLE_STARTING - Static variable in interface org.jline.reader.LineReader
Completion style for displaying the matching part of candidates
completionMatcher - Variable in class org.jline.reader.impl.LineReaderImpl
 
completionMatcher(CompletionMatcher) - Method in class org.jline.reader.LineReaderBuilder
 
CompletionMatcher - Interface in org.jline.reader
Interface for matching and filtering completion candidates.
CompletionMatcherImpl - Class in org.jline.reader.impl
Default implementation of the CompletionMatcher interface.
CompletionMatcherImpl() - Constructor for class org.jline.reader.impl.CompletionMatcherImpl
 
computePost(List<Candidate>, Candidate, List<Candidate>, String) - Method in class org.jline.reader.impl.LineReaderImpl
 
computePost(List<Candidate>, Candidate, List<Candidate>, String, Function<String, Integer>, int, boolean, boolean, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
configure(LineReader, InputStream) - Static method in class org.jline.reader.impl.InputRC
Configures a LineReader from an inputrc file.
configure(LineReader, Reader) - Static method in class org.jline.reader.impl.InputRC
Configures a LineReader from an inputrc file.
configure(LineReader, URL) - Static method in class org.jline.reader.impl.InputRC
Configures a LineReader from an inputrc file at the specified URL.
copy() - Method in interface org.jline.reader.Buffer
Creates a copy of this buffer.
copy() - Method in class org.jline.reader.impl.BufferImpl
 
COPY_PREV_WORD - Static variable in interface org.jline.reader.LineReader
 
COPY_REGION_AS_KILL - Static variable in interface org.jline.reader.LineReader
 
copyFrom(Buffer) - Method in interface org.jline.reader.Buffer
Copies the content and cursor position from another buffer.
copyFrom(Buffer) - Method in class org.jline.reader.impl.BufferImpl
 
copyPrevWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
copyRegionAsKill() - Method in class org.jline.reader.impl.LineReaderImpl
 
count - Variable in class org.jline.reader.impl.LineReaderImpl
 
createEntry(int, Instant, String) - Method in class org.jline.reader.impl.history.DefaultHistory
Create a history entry.
ctrl(char) - Static method in class org.jline.keymap.KeyMap
Creates a Ctrl+key sequence for a character.
CURLY - org.jline.reader.impl.DefaultParser.Bracket
 
currChar() - Method in interface org.jline.reader.Buffer
Returns the character at the current cursor position.
currChar() - Method in class org.jline.reader.impl.BufferImpl
 
currChar(int) - Method in interface org.jline.reader.Buffer
Replaces the character at the current cursor position.
currChar(int) - Method in class org.jline.reader.impl.BufferImpl
 
current() - Method in interface org.jline.reader.History
Return the content of the current buffer.
current() - Method in class org.jline.reader.impl.history.DefaultHistory
Returns the text of the history entry at the current cursor position.
currentLine - Variable in class org.jline.reader.impl.LineReaderImpl
 
cursor() - Method in interface org.jline.reader.Buffer
Returns the current cursor position in the buffer.
cursor() - Method in class org.jline.reader.impl.BufferImpl
 
cursor() - Method in class org.jline.reader.impl.completer.ArgumentCompleter.ArgumentLine
 
cursor() - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
cursor() - Method in interface org.jline.reader.ParsedLine
The cursor position within the line.
cursor(int) - Method in interface org.jline.reader.Buffer
Moves the cursor to the specified position.
cursor(int) - Method in class org.jline.reader.impl.BufferImpl
Move the cursor position to the specified absolute index.

D

deactivateRegion() - Method in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_AMBIGUOUS_BINDING - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_AMBIGUOUS_TIMEOUT - Static variable in class org.jline.keymap.KeyMap
Default timeout in milliseconds for ambiguous bindings.
DEFAULT_BELL_STYLE - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_BLINK_MATCHING_PAREN - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMMENT_BEGIN - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_BACKGROUND - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_DESCRIPTION - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_GROUP - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_LIST_BACKGROUND - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_LIST_DESCRIPTION - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_LIST_GROUP - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_LIST_SELECTION - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_LIST_STARTING - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_SELECTION - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_COMPLETION_STYLE_STARTING - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_ERRORS - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_FEATURES_MAX_BUFFER_SIZE - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_HISTORY_FILE_SIZE - Static variable in class org.jline.reader.impl.history.DefaultHistory
Default maximum number of history entries to keep in the history file.
DEFAULT_HISTORY_SIZE - Static variable in class org.jline.reader.impl.history.DefaultHistory
Default maximum number of history entries to keep in memory.
DEFAULT_INDENTATION - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_LIST_MAX - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_MAX_REPEAT_COUNT - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_MENU_LIST_MAX - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_ORIGINAL_GROUP_NAME - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_OTHERS_GROUP_NAME - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_REMOVE_SUFFIX_CHARS - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_SEARCH_TERMINATORS - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_SECONDARY_PROMPT_PATTERN - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_SUGGESTIONS_MIN_BUFFER_SIZE - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_SYSTEM_PROPERTY_PREFIX - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_TAB_WIDTH - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DEFAULT_WORDCHARS - Static variable in class org.jline.reader.impl.LineReaderImpl
 
DefaultExpander - Class in org.jline.reader.impl
Default implementation of the Expander interface.
DefaultExpander() - Constructor for class org.jline.reader.impl.DefaultExpander
 
DefaultHighlighter - Class in org.jline.reader.impl
Default implementation of the Highlighter interface.
DefaultHighlighter() - Constructor for class org.jline.reader.impl.DefaultHighlighter
 
DefaultHistory - Class in org.jline.reader.impl.history
Default implementation of History with file-based persistent storage.
DefaultHistory() - Constructor for class org.jline.reader.impl.history.DefaultHistory
Creates a new DefaultHistory instance.
DefaultHistory(LineReader) - Constructor for class org.jline.reader.impl.history.DefaultHistory
Creates a new DefaultHistory instance and attaches it to the specified LineReader.
DefaultHistory.EntryImpl - Class in org.jline.reader.impl.history
Default implementation of the History.Entry interface.
defaultKeyMaps() - Method in class org.jline.reader.impl.LineReaderImpl
 
defaultKeyMaps() - Method in interface org.jline.reader.LineReader
Returns the default key maps used by the LineReader.
defaultMatchers(Map<LineReader.Option, Boolean>, boolean, CompletingParsedLine, boolean, int, String) - Method in class org.jline.reader.impl.CompletionMatcherImpl
Default JLine matchers
DefaultParser - Class in org.jline.reader.impl
Default implementation of the Parser interface.
DefaultParser() - Constructor for class org.jline.reader.impl.DefaultParser
 
DefaultParser.ArgumentList - Class in org.jline.reader.impl
The result of a delimited buffer.
DefaultParser.BlockCommentDelims - Class in org.jline.reader.impl
Class representing block comment delimiters.
DefaultParser.Bracket - Enum in org.jline.reader.impl
Enumeration of bracket types that can be used for EOF detection on unclosed brackets.
del() - Static method in class org.jline.keymap.KeyMap
Returns the delete character as a string.
DELAY_LINE_WRAP - org.jline.reader.LineReader.Option
After writing into the rightmost column, do we immediately move to the next line (the default)? Or do we wait until the next character.
delete() - Method in interface org.jline.reader.Buffer
Deletes the character at the cursor position.
delete() - Method in class org.jline.reader.impl.BufferImpl
 
delete(int) - Method in interface org.jline.reader.Buffer
Deletes multiple characters starting at the cursor position.
delete(int) - Method in class org.jline.reader.impl.BufferImpl
 
DELETE - org.jline.reader.impl.LineReaderImpl.ViMoveMode
 
DELETE_CHAR - Static variable in interface org.jline.reader.LineReader
 
DELETE_CHAR_OR_LIST - Static variable in interface org.jline.reader.LineReader
 
DELETE_WORD - Static variable in interface org.jline.reader.LineReader
 
deleteChar() - Method in class org.jline.reader.impl.LineReaderImpl
 
deleteCharOrList() - Method in class org.jline.reader.impl.LineReaderImpl
 
deleteWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
descr() - Method in class org.jline.reader.Candidate
Description of this candidate, usually a small help message to understand the meaning of this candidate.
DIGIT_ARGUMENT - Static variable in interface org.jline.reader.LineReader
 
digitArgument() - Method in class org.jline.reader.impl.LineReaderImpl
 
DISABLE_COMPLETION - Static variable in interface org.jline.reader.LineReader
 
DISABLE_EVENT_EXPANSION - org.jline.reader.LineReader.Option
disable special handling of magic history expansion commands like "!" and "!!" and "!n" and "!-n" and "!string" and "^string1^string2", as well as [interpret escape characters](https://github.com/jline/jline3/issues/1238)
DISABLE_HIGHLIGHTER - org.jline.reader.LineReader.Option
 
DISABLE_HISTORY - Static variable in interface org.jline.reader.LineReader
 
DISABLE_UNDO - org.jline.reader.LineReader.Option
Disable the undo feature
displ() - Method in class org.jline.reader.Candidate
The string that will be displayed to the user.
display - Variable in class org.jline.reader.impl.LineReaderImpl
 
display(String) - Static method in class org.jline.keymap.KeyMap
Converts a key sequence to a displayable string representation.
display(String) - Method in class org.jline.reader.impl.SimpleMaskingCallback
 
display(String) - Method in interface org.jline.reader.MaskingCallback
Transforms the line before it is displayed so that sensitive parts can be hidden.
distance(String, String) - Static method in class org.jline.reader.impl.ReaderUtils
Calculates the edit distance between a word and a candidate string.
DO_LOWERCASE_VERSION - Static variable in interface org.jline.reader.LineReader
 
doAutosuggestion - Variable in class org.jline.reader.impl.LineReaderImpl
 
doCleanup(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
doComplete(LineReaderImpl.CompletionType, boolean, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
doComplete(LineReaderImpl.CompletionType, boolean, boolean, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
doInsertComment(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
doList(List<Candidate>, String, boolean, BiFunction<CharSequence, Boolean, CharSequence>) - Method in class org.jline.reader.impl.LineReaderImpl
 
doList(List<Candidate>, String, boolean, BiFunction<CharSequence, Boolean, CharSequence>, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
doLowercaseVersion() - Method in class org.jline.reader.impl.LineReaderImpl
 
doMenu(List<Candidate>, String, BiFunction<CharSequence, Boolean, CharSequence>) - Method in class org.jline.reader.impl.LineReaderImpl
 
DONE - org.jline.reader.impl.LineReaderImpl.State
readLine should exit and return the buffer content
doReadBinding(KeyMap<T>, KeyMap<T>) - Method in class org.jline.reader.impl.LineReaderImpl
 
doReadStringUntil(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
doSearchHistory(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
doViDeleteOrChange(int, int, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
Performs the vi "delete-to" action, deleting characters between a given span of the input line.
doViMatchBracket() - Method in class org.jline.reader.impl.LineReaderImpl
Implements vi style bracket matching ("%" command).
down() - Method in interface org.jline.reader.Buffer
Moves the cursor down one line while maintaining the same column position if possible.
down() - Method in class org.jline.reader.impl.BufferImpl
 
DOWN_CASE_WORD - Static variable in interface org.jline.reader.LineReader
 
DOWN_HISTORY - Static variable in interface org.jline.reader.LineReader
 
DOWN_LINE - Static variable in interface org.jline.reader.LineReader
 
DOWN_LINE_OR_HISTORY - Static variable in interface org.jline.reader.LineReader
 
DOWN_LINE_OR_SEARCH - Static variable in interface org.jline.reader.LineReader
 
downCaseWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
downHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
downLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
downLineOrHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
downLineOrSearch() - Method in class org.jline.reader.impl.LineReaderImpl
 
dumb() - Method in class org.jline.reader.impl.LineReaderImpl
 
DUMB - Static variable in interface org.jline.reader.LineReader
 

E

EDIT_AND_EXECUTE_COMMAND - Static variable in interface org.jline.reader.LineReader
 
editAndAddInBuffer(File) - Method in interface org.jline.reader.LineReader
Opens a file in an external editor and adds its contents to the input buffer.
editAndAddInBuffer(Path) - Method in class org.jline.reader.impl.LineReaderImpl
 
editAndAddInBuffer(Path) - Method in interface org.jline.reader.LineReader
Opens a file in an external editor and adds its contents to the input buffer.
editAndExecute() - Method in class org.jline.reader.impl.LineReaderImpl
 
EDITING_MODE - Static variable in interface org.jline.reader.LineReader
 
Editor - Interface in org.jline.reader
Interface for launching external editors from within a JLine application.
emacs() - Method in class org.jline.reader.impl.LineReaderImpl
 
EMACS - Static variable in interface org.jline.reader.LineReader
 
EMACS_BACKWARD_WORD - Static variable in interface org.jline.reader.LineReader
 
EMACS_EDITING_MODE - Static variable in interface org.jline.reader.LineReader
 
EMACS_FORWARD_WORD - Static variable in interface org.jline.reader.LineReader
 
emacsBackwardWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
emacsEditingMode() - Method in class org.jline.reader.impl.LineReaderImpl
 
emacsForwardWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
EMPTY_WORD_OPTIONS - org.jline.reader.LineReader.Option
Show command options tab completion candidates for zero length word
END_OF_BUFFER_OR_HISTORY - Static variable in interface org.jline.reader.LineReader
 
END_OF_HISTORY - Static variable in interface org.jline.reader.LineReader
 
END_OF_LINE - Static variable in interface org.jline.reader.LineReader
 
END_OF_LINE_HIST - Static variable in interface org.jline.reader.LineReader
 
endOfBufferOrHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
EndOfFileException - Exception in org.jline.reader
This exception is thrown by LineReader.readLine() when user the user types ctrl-D).
EndOfFileException() - Constructor for exception org.jline.reader.EndOfFileException
 
EndOfFileException(String) - Constructor for exception org.jline.reader.EndOfFileException
 
EndOfFileException(String, Throwable) - Constructor for exception org.jline.reader.EndOfFileException
 
EndOfFileException(String, Throwable, boolean, boolean) - Constructor for exception org.jline.reader.EndOfFileException
 
EndOfFileException(Throwable) - Constructor for exception org.jline.reader.EndOfFileException
 
endOfHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
endOfLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
endOfLineHist() - Method in class org.jline.reader.impl.LineReaderImpl
 
EntryImpl(int, Instant, String) - Constructor for class org.jline.reader.impl.history.DefaultHistory.EntryImpl
Creates a new history entry with the specified index, timestamp, and line.
EnumCompleter - Class in org.jline.reader.impl.completer
Completer for Enum names.
EnumCompleter(Class<? extends Enum<?>>) - Constructor for class org.jline.reader.impl.completer.EnumCompleter
 
EOF - org.jline.reader.impl.LineReaderImpl.State
readLine should exit and throw an EOFException
EOFError - Exception in org.jline.reader
Exception thrown when parsing is incomplete due to unexpected end of input.
EOFError(int, int, String) - Constructor for exception org.jline.reader.EOFError
 
EOFError(int, int, String, String) - Constructor for exception org.jline.reader.EOFError
 
EOFError(int, int, String, String, int, String) - Constructor for exception org.jline.reader.EOFError
 
eofOnEscapedNewLine(boolean) - Method in class org.jline.reader.impl.DefaultParser
Sets whether EOF should be returned on escaped newlines.
eofOnUnclosedBracket(DefaultParser.Bracket...) - Method in class org.jline.reader.impl.DefaultParser
Sets the bracket types that should trigger EOF on unclosed brackets.
eofOnUnclosedQuote(boolean) - Method in class org.jline.reader.impl.DefaultParser
Sets whether EOF should be returned on unclosed quotes.
equals(Object) - Method in class org.jline.reader.Candidate
 
equals(Object) - Method in class org.jline.reader.Macro
 
equals(Object) - Method in class org.jline.reader.Reference
 
ERASE_LINE_ON_FINISH - org.jline.reader.LineReader.Option
Instead of printing a new line when the line is read, the entire line (including the prompt) will be erased, thereby leaving the screen as it was before the readLine call.
errorIndex - Variable in class org.jline.reader.impl.DefaultHighlighter
 
errorPattern - Variable in class org.jline.reader.impl.DefaultHighlighter
 
ERRORS - Static variable in interface org.jline.reader.LineReader
Number of matching errors that are accepted by the completion matcher
esc() - Static method in class org.jline.keymap.KeyMap
Returns the escape character as a string.
escape(CharSequence, boolean) - Method in interface org.jline.reader.CompletingParsedLine
Escapes a completion candidate according to the parser's quoting and escaping rules.
escape(CharSequence, boolean) - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
escapeChars(char[]) - Method in class org.jline.reader.impl.DefaultParser
Sets the escape characters.
exact - Variable in class org.jline.reader.impl.CompletionMatcherImpl
 
exactMatch() - Method in interface org.jline.reader.CompletionMatcher
Returns a candidate that exactly matches the current input, if any.
exactMatch() - Method in class org.jline.reader.impl.CompletionMatcherImpl
 
EXCHANGE_POINT_AND_MARK - Static variable in interface org.jline.reader.LineReader
 
exchangePointAndMark() - Method in class org.jline.reader.impl.LineReaderImpl
 
EXECUTE_NAMED_CMD - Static variable in interface org.jline.reader.LineReader
 
Expand - org.jline.reader.impl.LineReaderImpl.CompletionType
 
EXPAND_HISTORY - Static variable in interface org.jline.reader.LineReader
 
EXPAND_OR_COMPLETE - Static variable in interface org.jline.reader.LineReader
 
EXPAND_OR_COMPLETE_PREFIX - Static variable in interface org.jline.reader.LineReader
 
EXPAND_WORD - Static variable in interface org.jline.reader.LineReader
 
ExpandComplete - org.jline.reader.impl.LineReaderImpl.CompletionType
 
expander - Variable in class org.jline.reader.impl.LineReaderImpl
 
expander(Expander) - Method in class org.jline.reader.LineReaderBuilder
 
Expander - Interface in org.jline.reader
The Expander interface provides functionality for expanding special syntax in command lines.
expandHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
expandHistory(History, String) - Method in interface org.jline.reader.Expander
Expands history references in the input line.
expandHistory(History, String) - Method in class org.jline.reader.impl.DefaultExpander
Expand event designator such as !!, !#, !3, etc...
expandOrComplete() - Method in class org.jline.reader.impl.LineReaderImpl
 
expandOrCompletePrefix() - Method in class org.jline.reader.impl.LineReaderImpl
 
expandVar(String) - Method in interface org.jline.reader.Expander
Expands variables in the input word.
expandVar(String) - Method in class org.jline.reader.impl.DefaultExpander
 
expandWord() - Method in class org.jline.reader.impl.LineReaderImpl
 

F

FEATURES_MAX_BUFFER_SIZE - Static variable in interface org.jline.reader.LineReader
Max buffer size for advanced features.
FileNameCompleter - Class in org.jline.reader.impl.completer
Deprecated.
use org.jline.builtins.Completers$FileNameCompleter instead
FileNameCompleter() - Constructor for class org.jline.reader.impl.completer.FileNameCompleter
Deprecated.
 
findChar - Variable in class org.jline.reader.impl.LineReaderImpl
VI character find
findDir - Variable in class org.jline.reader.impl.LineReaderImpl
 
findTailAdd - Variable in class org.jline.reader.impl.LineReaderImpl
 
finish(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
finishBuffer() - Method in class org.jline.reader.impl.LineReaderImpl
Clear the buffer and add its contents to the history.
first() - Method in interface org.jline.reader.History
Returns the index of the first element in the history.
first() - Method in class org.jline.reader.impl.history.DefaultHistory
 
flush() - Method in class org.jline.reader.impl.LineReaderImpl
Flush the terminal output stream.
flush() - Method in class org.jline.reader.PrintAboveWriter
 
FOCUS_IN - Static variable in interface org.jline.reader.LineReader
 
FOCUS_IN_SEQ - Static variable in class org.jline.reader.impl.LineReaderImpl
 
FOCUS_OUT - Static variable in interface org.jline.reader.LineReader
 
FOCUS_OUT_SEQ - Static variable in class org.jline.reader.impl.LineReaderImpl
 
focusIn() - Method in class org.jline.reader.impl.LineReaderImpl
 
focusOut() - Method in class org.jline.reader.impl.LineReaderImpl
 
FORWARD_CHAR - Static variable in interface org.jline.reader.LineReader
 
FORWARD_WORD - Static variable in interface org.jline.reader.LineReader
 
forwardChar() - Method in class org.jline.reader.impl.LineReaderImpl
 
forwardWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
FRESH_LINE - Static variable in interface org.jline.reader.LineReader
 
freshLine() - Method in class org.jline.reader.impl.LineReaderImpl
 

G

get(int) - Method in interface org.jline.reader.History
Returns the history item at the specified index.
get(int) - Method in class org.jline.reader.impl.history.DefaultHistory
 
getAmbiguousTimeout() - Method in class org.jline.keymap.KeyMap
Gets the timeout for ambiguous key bindings in milliseconds.
getAnotherKey() - Method in class org.jline.keymap.KeyMap
Gets the binding for the "another key" action.
getAppName() - Method in class org.jline.reader.impl.LineReaderImpl
 
getAppName() - Method in interface org.jline.reader.LineReader
Returns the application name associated with this LineReader.
getAutosuggestion() - Method in class org.jline.reader.impl.LineReaderImpl
 
getAutosuggestion() - Method in interface org.jline.reader.LineReader
Returns the current auto-suggestion type.
getBlockCommentDelims() - Method in class org.jline.reader.impl.DefaultParser
Gets the block comment delimiters.
getBoolean(LineReader, String, boolean) - Static method in class org.jline.reader.impl.ReaderUtils
Gets a boolean variable from a LineReader with a default value.
getBound(CharSequence) - Method in class org.jline.keymap.KeyMap
Gets the binding for a key sequence.
getBound(CharSequence, int[]) - Method in class org.jline.keymap.KeyMap
Gets the binding for a key sequence, with information about remaining characters.
getBoundKeys() - Method in class org.jline.keymap.KeyMap
Returns a map of all bound key sequences and their associated bindings.
getBracketType(int) - Method in class org.jline.reader.impl.LineReaderImpl
Given a character determines what type of bracket it is (paren, square, curly, or none).
getBuffer() - Method in class org.jline.reader.impl.LineReaderImpl
 
getBuffer() - Method in interface org.jline.reader.LineReader
Returns the current line buffer.
getBuiltinWidgets() - Method in class org.jline.reader.impl.LineReaderImpl
 
getBuiltinWidgets() - Method in interface org.jline.reader.LineReader
Returns a map of all built-in widgets provided by the LineReader.
getCandidateComparator(boolean, String) - Method in class org.jline.reader.impl.LineReaderImpl
 
getCommand(String) - Method in class org.jline.reader.impl.DefaultParser
 
getCommand(String) - Method in interface org.jline.reader.Parser
 
getCommonPrefix() - Method in interface org.jline.reader.CompletionMatcher
Returns the longest common prefix shared by all matched candidates.
getCommonPrefix() - Method in class org.jline.reader.impl.CompletionMatcherImpl
 
getCompleter() - Method in class org.jline.reader.impl.LineReaderImpl
Returns the completer.
getCompleters() - Method in class org.jline.reader.impl.completer.AggregateCompleter
Retrieve the collection of completers currently being aggregated.
getCompleters() - Method in class org.jline.reader.impl.completer.ArgumentCompleter
Returns the list of completers used inside this ArgumentCompleter.
getCompleters() - Method in class org.jline.reader.impl.completer.SystemCompleter
 
getCompletionStyle(String, String) - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleBackground() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleBackground(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleDescription() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleDescription(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleGroup() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleGroup(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleListBackground() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleListDescription() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleListGroup() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleListSelection() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleListStarting() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleSelection() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleSelection(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleStarting() - Method in class org.jline.reader.impl.LineReaderImpl
 
getCompletionStyleStarting(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
getCurrentBuffer() - Method in class org.jline.keymap.BindingReader
Returns the current contents of the operation buffer.
getDisplay(Terminal, Path) - Method in class org.jline.reader.impl.completer.FileNameCompleter
Deprecated.
 
getDisplayedBufferWithPrompts(List<AttributedString>) - Method in class org.jline.reader.impl.LineReaderImpl
Compute the full string to be displayed with the left, right and secondary prompts
getEnd() - Method in class org.jline.reader.impl.DefaultParser.BlockCommentDelims
 
getEscapeChars() - Method in class org.jline.reader.impl.DefaultParser
Gets the escape characters.
getExpander() - Method in class org.jline.reader.impl.LineReaderImpl
 
getExpander() - Method in interface org.jline.reader.LineReader
Returns the expander associated with this LineReader.
getGroupComparator() - Method in class org.jline.reader.impl.LineReaderImpl
 
getHighlighter() - Method in class org.jline.reader.impl.LineReaderImpl
 
getHighlighter() - Method in interface org.jline.reader.LineReader
Returns the highlighter associated with this LineReader.
getHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
getHistory() - Method in interface org.jline.reader.LineReader
Returns the history associated with this LineReader.
getInt(LineReader, String, int) - Static method in class org.jline.reader.impl.ReaderUtils
Gets an integer variable from a LineReader with a default value.
getKeyMap() - Method in class org.jline.reader.impl.LineReaderImpl
Returns the name of the current key mapping.
getKeyMap() - Method in interface org.jline.reader.LineReader
Returns the name of the currently active key map.
getKeyMaps() - Method in class org.jline.reader.impl.LineReaderImpl
 
getKeyMaps() - Method in interface org.jline.reader.LineReader
Returns all key maps registered with this LineReader.
getKeys() - Method in class org.jline.reader.impl.LineReaderImpl
 
getKeys() - Method in interface org.jline.reader.LineReader
Returns the currently active key map.
getLastBinding() - Method in class org.jline.keymap.BindingReader
Returns the last key binding that was successfully read.
getLastBinding() - Method in class org.jline.reader.impl.LineReaderImpl
 
getLastBinding() - Method in interface org.jline.reader.LineReader
Returns the last key binding that was processed.
getLineCommentDelims() - Method in class org.jline.reader.impl.DefaultParser
Gets the line comment delimiters.
getLong(LineReader, String, long) - Static method in class org.jline.reader.impl.ReaderUtils
Gets a long variable from a LineReader with a default value.
getMissing() - Method in exception org.jline.reader.EOFError
Returns the string that is missing to complete the input.
getNextClosingBracket() - Method in exception org.jline.reader.EOFError
Returns the next closing bracket that is expected.
getNomatch() - Method in class org.jline.keymap.KeyMap
Gets the binding for input sequences that don't match any known binding.
getOpenBrackets() - Method in exception org.jline.reader.EOFError
Returns the number of unclosed brackets in the input.
getOriginalGroupName() - Method in class org.jline.reader.impl.LineReaderImpl
 
getOthersGroupName() - Method in class org.jline.reader.impl.LineReaderImpl
 
getParsedLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
getParsedLine() - Method in interface org.jline.reader.LineReader
Returns the parsed representation of the current line.
getParser() - Method in class org.jline.reader.impl.LineReaderImpl
 
getParser() - Method in interface org.jline.reader.LineReader
Returns the parser associated with this LineReader.
getPartialLine() - Method in exception org.jline.reader.EndOfFileException
 
getPartialLine() - Method in exception org.jline.reader.UserInterruptException
 
getQuoteChars() - Method in class org.jline.reader.impl.DefaultParser
Gets the quote characters.
getRegionActive() - Method in class org.jline.reader.impl.LineReaderImpl
 
getRegionActive() - Method in interface org.jline.reader.LineReader
Returns the type of the currently active region selection.
getRegionMark() - Method in class org.jline.reader.impl.LineReaderImpl
 
getRegionMark() - Method in interface org.jline.reader.LineReader
Returns the mark position of the currently active region.
getSearchTerm() - Method in class org.jline.reader.impl.LineReaderImpl
 
getSearchTerm() - Method in interface org.jline.reader.LineReader
Returns the current search term when in history search mode.
getSequence() - Method in class org.jline.reader.Macro
Returns the keystroke sequence that this macro will execute.
getStart() - Method in class org.jline.reader.impl.DefaultParser.BlockCommentDelims
 
getString(LineReader, String, String) - Static method in class org.jline.reader.impl.ReaderUtils
Gets a string variable from a LineReader with a default value.
getTabWidth() - Method in class org.jline.reader.impl.LineReaderImpl
 
getTailTip() - Method in class org.jline.reader.impl.LineReaderImpl
 
getTailTip() - Method in interface org.jline.reader.LineReader
Returns the current tail tip text.
getTerminal() - Method in class org.jline.reader.impl.LineReaderImpl
 
getTerminal() - Method in interface org.jline.reader.LineReader
Returns the terminal associated with this LineReader.
getUnicode() - Method in class org.jline.keymap.KeyMap
Gets the binding for Unicode characters that don't have explicit bindings.
getUserDir() - Method in class org.jline.reader.impl.completer.FileNameCompleter
Deprecated.
 
getUserHome() - Method in class org.jline.reader.impl.completer.FileNameCompleter
Deprecated.
 
getVariable(String) - Method in class org.jline.reader.impl.DefaultParser
 
getVariable(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
getVariable(String) - Method in interface org.jline.reader.LineReader
Returns the value of a variable.
getVariable(String) - Method in interface org.jline.reader.Parser
 
getVariables() - Method in class org.jline.reader.impl.LineReaderImpl
 
getVariables() - Method in interface org.jline.reader.LineReader
Returns a map of all variables set in the LineReader.
getWidget(Object) - Method in class org.jline.reader.impl.LineReaderImpl
 
getWidgets() - Method in class org.jline.reader.impl.LineReaderImpl
 
getWidgets() - Method in interface org.jline.reader.LineReader
Returns a map of all widgets registered with this LineReader.
GLOB_COMPLETE - org.jline.reader.LineReader.Option
 
group() - Method in class org.jline.reader.Candidate
The group name for this candidate.
GROUP - org.jline.reader.LineReader.Option
display group name before each group (else display all group names first)
GROUP_PERSIST - org.jline.reader.LineReader.Option
when double tab to select candidate keep candidates grouped (else loose grouping)

H

handleSignal(Terminal.Signal) - Method in class org.jline.reader.impl.LineReaderImpl
 
hashCode() - Method in class org.jline.reader.Candidate
 
hashCode() - Method in class org.jline.reader.Macro
 
hashCode() - Method in class org.jline.reader.Reference
 
highlight(LineReader, String) - Method in interface org.jline.reader.Highlighter
Highlights the provided text buffer with appropriate styling.
highlight(LineReader, String) - Method in class org.jline.reader.impl.DefaultHighlighter
 
highlighter - Variable in class org.jline.reader.impl.LineReaderImpl
 
highlighter(Highlighter) - Method in class org.jline.reader.LineReaderBuilder
Sets the highlighter to be used for syntax highlighting.
Highlighter - Interface in org.jline.reader
The Highlighter interface provides syntax highlighting functionality for the LineReader.
history - Variable in class org.jline.reader.impl.LineReaderImpl
 
history(String) - Method in class org.jline.reader.impl.SimpleMaskingCallback
 
history(String) - Method in interface org.jline.reader.MaskingCallback
Transforms the line before storing it in the history.
history(History) - Method in class org.jline.reader.LineReaderBuilder
 
History - Interface in org.jline.reader
Console command history management interface.
HISTORY - org.jline.reader.LineReader.SuggestionType
Prepare command line suggestions using command history.
HISTORY_BEEP - org.jline.reader.LineReader.Option
 
HISTORY_BEGINNING_SEARCH_BACKWARD - Static variable in interface org.jline.reader.LineReader
 
HISTORY_BEGINNING_SEARCH_FORWARD - Static variable in interface org.jline.reader.LineReader
 
HISTORY_FILE - Static variable in interface org.jline.reader.LineReader
File system history path.
HISTORY_FILE_SIZE - Static variable in interface org.jline.reader.LineReader
Number of history items to keep in the history file.
HISTORY_IGNORE - Static variable in interface org.jline.reader.LineReader
Colon separated list of patterns that will not be saved in history.
HISTORY_IGNORE_DUPS - org.jline.reader.LineReader.Option
 
HISTORY_IGNORE_SPACE - org.jline.reader.LineReader.Option
 
HISTORY_INCREMENTAL - org.jline.reader.LineReader.Option
automatically save history when the line reader reads a new line (enabled by default)
HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD - Static variable in interface org.jline.reader.LineReader
 
HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD - Static variable in interface org.jline.reader.LineReader
 
HISTORY_INCREMENTAL_SEARCH_BACKWARD - Static variable in interface org.jline.reader.LineReader
 
HISTORY_INCREMENTAL_SEARCH_FORWARD - Static variable in interface org.jline.reader.LineReader
 
HISTORY_REDUCE_BLANKS - org.jline.reader.LineReader.Option
 
HISTORY_SEARCH_BACKWARD - Static variable in interface org.jline.reader.LineReader
 
HISTORY_SEARCH_FORWARD - Static variable in interface org.jline.reader.LineReader
 
HISTORY_SIZE - Static variable in interface org.jline.reader.LineReader
Number of history items to keep in memory.
HISTORY_TIMESTAMPED - org.jline.reader.LineReader.Option
 
HISTORY_VERIFY - org.jline.reader.LineReader.Option
 
History.Entry - Interface in org.jline.reader
Represents a single history entry containing a command line and its metadata.
historyBuffer - Variable in class org.jline.reader.impl.LineReaderImpl
 
historyIncrementalSearchBackward() - Method in class org.jline.reader.impl.LineReaderImpl
 
historyIncrementalSearchForward() - Method in class org.jline.reader.impl.LineReaderImpl
 
historySearchBackward() - Method in class org.jline.reader.impl.LineReaderImpl
 
historySearchForward() - Method in class org.jline.reader.impl.LineReaderImpl
 

I

IGNORE - org.jline.reader.impl.LineReaderImpl.State
readLine should exit and return empty String
INDENTATION - Static variable in interface org.jline.reader.LineReader
New line automatic indentation after opening/closing bracket.
index() - Method in interface org.jline.reader.History.Entry
Returns the index of this entry in the history.
index() - Method in interface org.jline.reader.History
Returns the current index in the history.
index() - Method in class org.jline.reader.impl.history.DefaultHistory.EntryImpl
 
index() - Method in class org.jline.reader.impl.history.DefaultHistory
 
INFER_NEXT_HISTORY - Static variable in interface org.jline.reader.LineReader
 
INPUT_RC_FILE_NAME - Static variable in interface org.jline.reader.LineReader
Name of inputrc to read at line reader creation time.
InputRC - Class in org.jline.reader.impl
Handles inputrc configuration files for JLine.
INSERT_BRACKET - org.jline.reader.LineReader.Option
Automatic insertion of closing bracket
INSERT_CLOSE_CURLY - Static variable in interface org.jline.reader.LineReader
 
INSERT_CLOSE_PAREN - Static variable in interface org.jline.reader.LineReader
 
INSERT_CLOSE_SQUARE - Static variable in interface org.jline.reader.LineReader
 
INSERT_COMMENT - Static variable in interface org.jline.reader.LineReader
 
INSERT_LAST_WORD - Static variable in interface org.jline.reader.LineReader
 
INSERT_TAB - org.jline.reader.LineReader.Option
When hitting the <tab> key at the beginning of the line, insert a tabulation instead of completing.
insertClose(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
insertCloseCurly() - Method in class org.jline.reader.impl.LineReaderImpl
 
insertCloseParen() - Method in class org.jline.reader.impl.LineReaderImpl
 
insertCloseSquare() - Method in class org.jline.reader.impl.LineReaderImpl
 
insertComment() - Method in class org.jline.reader.impl.LineReaderImpl
 
insertTab() - Method in class org.jline.reader.impl.LineReaderImpl
 
INSTANCE - Static variable in class org.jline.reader.impl.completer.NullCompleter
 
internalAdd(Instant, String) - Method in class org.jline.reader.impl.history.DefaultHistory
Adds a line to the history with the specified timestamp.
internalAdd(Instant, String, boolean) - Method in class org.jline.reader.impl.history.DefaultHistory
Adds a line to the history with the specified timestamp and an option to check for duplicates.
INTERRUPT - org.jline.reader.impl.LineReaderImpl.State
readLine should exit and throw an UserInterruptException
isAlpha(int) - Method in class org.jline.reader.impl.LineReaderImpl
 
isArgDigit - Variable in class org.jline.reader.impl.LineReaderImpl
 
isCompiled() - Method in class org.jline.reader.impl.completer.SystemCompleter
 
isDef() - Method in enum org.jline.reader.LineReader.Option
 
isDelimiter(int) - Method in class org.jline.reader.impl.LineReaderImpl
Checks to see if the specified character is a delimiter.
isDelimiter(CharSequence, int) - Method in class org.jline.reader.impl.DefaultParser
Returns true if the specified character is a whitespace parameter.
isDelimiterChar(CharSequence, int) - Method in class org.jline.reader.impl.DefaultParser
Returns true if the character at the specified position if a delimiter.
isEmpty() - Method in interface org.jline.reader.History
Checks if the history is empty.
isEmpty() - Method in class org.jline.reader.impl.history.DefaultHistory
 
isEofOnEscapedNewLine() - Method in class org.jline.reader.impl.DefaultParser
Checks if EOF should be returned on escaped newlines.
isEofOnUnclosedQuote() - Method in class org.jline.reader.impl.DefaultParser
Checks if EOF should be returned on unclosed quotes.
isEscapeChar(char) - Method in class org.jline.reader.impl.DefaultParser
 
isEscapeChar(char) - Method in interface org.jline.reader.Parser
 
isEscapeChar(CharSequence, int) - Method in class org.jline.reader.impl.DefaultParser
Check if this character is a valid escape char (i.e.
isEscaped(CharSequence, int) - Method in class org.jline.reader.impl.DefaultParser
Check if a character is escaped (i.e.
isInViChangeOperation() - Method in class org.jline.reader.impl.LineReaderImpl
 
isInViCmdMode() - Method in class org.jline.reader.impl.LineReaderImpl
 
isInViMoveOperation() - Method in class org.jline.reader.impl.LineReaderImpl
 
isKeyMap(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
isLineCommentStarted(CharSequence, int) - Method in class org.jline.reader.impl.DefaultParser
 
isPersistable(History.Entry) - Method in interface org.jline.reader.History
Check if an entry should be persisted or not.
isQuoteChar(CharSequence, int) - Method in class org.jline.reader.impl.DefaultParser
 
isQuoted(CharSequence, int) - Method in class org.jline.reader.impl.DefaultParser
 
isReading() - Method in class org.jline.reader.impl.LineReaderImpl
 
isReading() - Method in interface org.jline.reader.LineReader
Check if a thread is currently in a readLine() call.
isSet(Map<LineReader.Option, Boolean>) - Method in enum org.jline.reader.LineReader.Option
 
isSet(LineReader.Option) - Method in class org.jline.reader.impl.LineReaderImpl
 
isSet(LineReader.Option) - Method in interface org.jline.reader.LineReader
Checks if an option is set.
isSet(LineReader, LineReader.Option) - Static method in class org.jline.reader.impl.ReaderUtils
Checks if a LineReader option is set.
isStrict() - Method in class org.jline.reader.impl.completer.ArgumentCompleter
Returns whether a completion at argument index N will success if all the completions from arguments 0-(N-1) also succeed.
isUndo - Variable in class org.jline.reader.impl.LineReaderImpl
 
isViAlphaNum(int) - Method in class org.jline.reader.impl.LineReaderImpl
 
isWhitespace(int) - Method in class org.jline.reader.impl.LineReaderImpl
Checks to see if a character is a whitespace character.
isWord(int) - Method in class org.jline.reader.impl.LineReaderImpl
 
iterator() - Method in interface org.jline.reader.History
 
iterator(int) - Method in interface org.jline.reader.History
Returns a list iterator over the history entries starting at the specified index.
iterator(int) - Method in class org.jline.reader.impl.history.DefaultHistory
 

K

key() - Method in class org.jline.reader.Candidate
Candidates which have the same key will be merged together.
key(Terminal, InfoCmp.Capability) - Static method in class org.jline.keymap.KeyMap
Returns the escape sequence for a terminal capability.
keyMap - Variable in class org.jline.reader.impl.LineReaderImpl
 
KeyMap<T> - Class in org.jline.keymap
The KeyMap class maps keyboard input sequences to operations or actions.
KeyMap() - Constructor for class org.jline.keymap.KeyMap
 
KEYMAP - Static variable in interface org.jline.reader.LineReader
 
KEYMAP_LENGTH - Static variable in class org.jline.keymap.KeyMap
The size of the direct mapping array for ASCII characters.
keyMaps - Variable in class org.jline.reader.impl.LineReaderImpl
The terminal keys mapping
KEYSEQ_COMPARATOR - Static variable in class org.jline.keymap.KeyMap
Comparator for sorting key sequences.
KILL_BUFFER - Static variable in interface org.jline.reader.LineReader
 
KILL_LINE - Static variable in interface org.jline.reader.LineReader
 
KILL_REGION - Static variable in interface org.jline.reader.LineReader
 
KILL_WHOLE_LINE - Static variable in interface org.jline.reader.LineReader
 
KILL_WORD - Static variable in interface org.jline.reader.LineReader
 
killBuffer() - Method in class org.jline.reader.impl.LineReaderImpl
 
killLine() - Method in class org.jline.reader.impl.LineReaderImpl
Kill the buffer ahead of the current cursor position.
killRegion() - Method in class org.jline.reader.impl.LineReaderImpl
 
killRing - Variable in class org.jline.reader.impl.LineReaderImpl
 
KillRing - Class in org.jline.reader.impl
The kill ring class keeps killed text in a fixed size ring.
KillRing() - Constructor for class org.jline.reader.impl.KillRing
Creates a new kill ring of the default size.
KillRing(int) - Constructor for class org.jline.reader.impl.KillRing
Creates a new kill ring of the given size.
killWholeLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
killWord() - Method in class org.jline.reader.impl.LineReaderImpl
 

L

last() - Method in interface org.jline.reader.History
Returns the index of the last element in the history.
last() - Method in class org.jline.reader.impl.history.DefaultHistory
 
lastBinding - Variable in class org.jline.keymap.BindingReader
The last key binding that was matched
lastYank() - Method in class org.jline.reader.impl.KillRing
Returns true if the last command was a yank.
length() - Method in interface org.jline.reader.Buffer
Returns the length of the buffer.
length() - Method in class org.jline.reader.impl.BufferImpl
 
line() - Method in interface org.jline.reader.History.Entry
Returns the command line text of this entry.
line() - Method in class org.jline.reader.impl.completer.ArgumentCompleter.ArgumentLine
 
line() - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
line() - Method in class org.jline.reader.impl.history.DefaultHistory.EntryImpl
 
line() - Method in interface org.jline.reader.ParsedLine
The unparsed line.
line() - Method in exception org.jline.reader.SyntaxError
Returns the line number where the syntax error occurred.
LINE - org.jline.reader.LineReader.RegionType
 
LINE_OFFSET - Static variable in interface org.jline.reader.LineReader
When in multiline edit mode, this variable can be used to offset the line number displayed.
lineCommentDelims(String[]) - Method in class org.jline.reader.impl.DefaultParser
Sets the line comment delimiters.
LineReader - Interface in org.jline.reader
Read lines from the console, with input editing.
LineReader.Option - Enum in org.jline.reader
 
LineReader.RegionType - Enum in org.jline.reader
 
LineReader.SuggestionType - Enum in org.jline.reader
 
LineReaderBuilder - Class in org.jline.reader
A builder for creating and configuring LineReader instances.
LineReaderImpl - Class in org.jline.reader.impl
The default implementation of the LineReader interface.
LineReaderImpl(Terminal) - Constructor for class org.jline.reader.impl.LineReaderImpl
 
LineReaderImpl(Terminal, String) - Constructor for class org.jline.reader.impl.LineReaderImpl
 
LineReaderImpl(Terminal, String, Map<String, Object>) - Constructor for class org.jline.reader.impl.LineReaderImpl
 
LineReaderImpl.BellType - Enum in org.jline.reader.impl
 
LineReaderImpl.CompletionType - Enum in org.jline.reader.impl
 
LineReaderImpl.PostResult - Class in org.jline.reader.impl
 
LineReaderImpl.State - Enum in org.jline.reader.impl
Possible states in which the current readline operation may be in.
LineReaderImpl.ViMoveMode - Enum in org.jline.reader.impl
 
List - org.jline.reader.impl.LineReaderImpl.CompletionType
 
LIST_AMBIGUOUS - org.jline.reader.LineReader.Option
 
LIST_CHOICES - Static variable in interface org.jline.reader.LineReader
 
LIST_EXPAND - Static variable in interface org.jline.reader.LineReader
 
LIST_MAX - Static variable in interface org.jline.reader.LineReader
tab completion: if candidates are more than list-max a question will be asked before displaying them
LIST_PACKED - org.jline.reader.LineReader.Option
 
LIST_ROWS_FIRST - org.jline.reader.LineReader.Option
 
listChoices() - Method in class org.jline.reader.impl.LineReaderImpl
 
load() - Method in interface org.jline.reader.History
Load history.
load() - Method in class org.jline.reader.impl.history.DefaultHistory
Loads history from the file specified by the LineReader.HISTORY_FILE variable.
lock - Variable in class org.jline.reader.impl.LineReaderImpl
State lock

M

Macro - Class in org.jline.reader
A macro that executes a sequence of keystrokes when invoked.
Macro(String) - Constructor for class org.jline.reader.Macro
 
MAGIC_SPACE - Static variable in interface org.jline.reader.LineReader
 
MAIN - Static variable in interface org.jline.reader.LineReader
 
maskingCallback - Variable in class org.jline.reader.impl.LineReaderImpl
 
MaskingCallback - Interface in org.jline.reader
Callback used to mask parts of the line for sensitive input like passwords.
maskThread - Variable in class org.jline.reader.impl.LineReaderImpl
 
matchers - Variable in class org.jline.reader.impl.CompletionMatcherImpl
 
matches(List<Candidate>) - Method in interface org.jline.reader.CompletionMatcher
Filters the provided candidates based on the current matching criteria.
matches(List<Candidate>) - Method in class org.jline.reader.impl.CompletionMatcherImpl
 
matchPatterns(String, String) - Method in class org.jline.reader.impl.history.DefaultHistory
Checks if a line matches any of the specified patterns.
MAX_REPEAT_COUNT - Static variable in interface org.jline.reader.LineReader
Max number of times a command can be repeated.
menu() - Method in class org.jline.reader.impl.LineReaderImpl
 
MENU - Static variable in interface org.jline.reader.LineReader
 
MENU_COMPLETE - org.jline.reader.LineReader.Option
 
MENU_COMPLETE - Static variable in interface org.jline.reader.LineReader
 
MENU_EXPAND_OR_COMPLETE - Static variable in interface org.jline.reader.LineReader
 
MENU_LIST_MAX - Static variable in interface org.jline.reader.LineReader
tab completion: if candidates are less than menu-list-max they are displayed in a list below the field to be completed
MENU_SELECT - Static variable in interface org.jline.reader.LineReader
 
menuComplete() - Method in class org.jline.reader.impl.LineReaderImpl
 
menuExpandOrComplete() - Method in class org.jline.reader.impl.LineReaderImpl
 
modifiedHistory - Variable in class org.jline.reader.impl.LineReaderImpl
 
mouse() - Method in class org.jline.reader.impl.LineReaderImpl
 
MOUSE - org.jline.reader.LineReader.Option
 
MOUSE - Static variable in interface org.jline.reader.LineReader
 
move(int) - Method in interface org.jline.reader.Buffer
Moves the cursor by the specified number of characters.
move(int) - Method in class org.jline.reader.impl.BufferImpl
Move the cursor where characters.
moveHistory(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
Move up or down the history tree.
moveHistory(boolean, int) - Method in class org.jline.reader.impl.LineReaderImpl
Used in "vi" mode for argumented history move, to move a specific number of history entries forward or back.
moveTo(int) - Method in interface org.jline.reader.History
Move to the specified index in the history
moveTo(int) - Method in class org.jline.reader.impl.history.DefaultHistory
Moves the history cursor to the specified index.
moveToEnd() - Method in interface org.jline.reader.History
Move to the end of the history buffer.
moveToEnd() - Method in class org.jline.reader.impl.history.DefaultHistory
Moves the history cursor to the end of the history buffer.
moveToFirst() - Method in interface org.jline.reader.History
Moves the history index to the first entry.
moveToFirst() - Method in class org.jline.reader.impl.history.DefaultHistory
Moves the history cursor to the first entry.
moveToLast() - Method in interface org.jline.reader.History
This moves the history to the last entry.
moveToLast() - Method in class org.jline.reader.impl.history.DefaultHistory
Moves the history cursor to the last entry.
moveXY(int, int) - Method in interface org.jline.reader.Buffer
Moves the cursor by the specified number of columns and rows.
moveXY(int, int) - Method in class org.jline.reader.impl.BufferImpl
 
mult - Variable in class org.jline.reader.impl.LineReaderImpl
 

N

name() - Method in class org.jline.reader.Reference
Returns the name of the referenced widget.
NEG_ARGUMENT - Static variable in interface org.jline.reader.LineReader
 
negArgument() - Method in class org.jline.reader.impl.LineReaderImpl
 
newState(T) - Method in class org.jline.reader.impl.UndoTree
 
next() - Method in interface org.jline.reader.History
Move the pointer to the next element in the buffer.
next() - Method in class org.jline.reader.impl.history.DefaultHistory
Moves the history cursor to the next (newer) entry.
nextBindingIsComplete() - Method in class org.jline.reader.impl.LineReaderImpl
 
nextChar() - Method in interface org.jline.reader.Buffer
Returns the character after the current cursor position.
nextChar() - Method in class org.jline.reader.impl.BufferImpl
 
nextCommandFromHistory - Variable in class org.jline.reader.impl.LineReaderImpl
 
nextHistoryId - Variable in class org.jline.reader.impl.LineReaderImpl
 
NONE - org.jline.reader.impl.LineReaderImpl.BellType
 
NONE - org.jline.reader.LineReader.RegionType
 
NONE - org.jline.reader.LineReader.SuggestionType
As you type command line suggestions are disabled.
NORMAL - org.jline.reader.impl.LineReaderImpl.State
The user is just typing away
NORMAL - org.jline.reader.impl.LineReaderImpl.ViMoveMode
 
NULL_MASK - Static variable in class org.jline.reader.impl.LineReaderImpl
 
NullCompleter - Class in org.jline.reader.impl.completer
Null completer.
NullCompleter() - Constructor for class org.jline.reader.impl.completer.NullCompleter
 

O

opBuffer - Variable in class org.jline.keymap.BindingReader
Buffer for storing characters during key sequence processing
open(List<String>) - Method in interface org.jline.reader.Editor
Opens the specified files in the external editor.
option(LineReader.Option, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
option(LineReader.Option, boolean) - Method in interface org.jline.reader.LineReader
Sets an option in the LineReader and returns the LineReader for method chaining.
option(LineReader.Option, boolean) - Method in class org.jline.reader.LineReaderBuilder
 
options - Variable in class org.jline.reader.impl.LineReaderImpl
 
org.jline.keymap - package org.jline.keymap
JLine 3 Keymap Package - Components for handling keyboard input and key bindings.
org.jline.reader - package org.jline.reader
JLine 3 Reader Package - Core components for building interactive command-line interfaces.
org.jline.reader.impl - package org.jline.reader.impl
JLine 3 Reader Implementation Package.
org.jline.reader.impl.completer - package org.jline.reader.impl.completer
JLine 3 Completer Implementations.
org.jline.reader.impl.history - package org.jline.reader.impl.history
JLine 3 History Implementation Package.
ORIGINAL_GROUP_NAME - Static variable in interface org.jline.reader.LineReader
Property for the "original" group name
OTHERS_GROUP_NAME - Static variable in interface org.jline.reader.LineReader
Property for the "others" group name
overTyping - Variable in class org.jline.reader.impl.LineReaderImpl
 
OVERWRITE_MODE - Static variable in interface org.jline.reader.LineReader
 
overwriteMode() - Method in class org.jline.reader.impl.LineReaderImpl
 

P

parse(String, int) - Method in interface org.jline.reader.Parser
 
parse(String, int, Parser.ParseContext) - Method in class org.jline.reader.impl.DefaultParser
 
parse(String, int, Parser.ParseContext) - Method in interface org.jline.reader.Parser
 
parsedLine - Variable in class org.jline.reader.impl.LineReaderImpl
 
ParsedLine - Interface in org.jline.reader
ParsedLine objects are returned by the Parser during completion or when accepting the line.
parser - Variable in class org.jline.reader.impl.LineReaderImpl
 
parser(Parser) - Method in class org.jline.reader.LineReaderBuilder
Sets the parser to be used for parsing command lines.
Parser - Interface in org.jline.reader
The Parser interface is responsible for parsing command lines into tokens.
Parser.ParseContext - Enum in org.jline.reader
 
partialLine(String) - Method in exception org.jline.reader.EndOfFileException
 
PASTE - org.jline.reader.LineReader.RegionType
 
peekCharacter(long) - Method in class org.jline.keymap.BindingReader
Peeks at the next character in the input stream without consuming it.
peekCharacter(long) - Method in class org.jline.reader.impl.LineReaderImpl
 
post - Variable in class org.jline.reader.impl.LineReaderImpl
 
PostResult(AttributedString, int, int) - Constructor for class org.jline.reader.impl.LineReaderImpl.PostResult
 
PREFER_VISIBLE_BELL - Static variable in interface org.jline.reader.LineReader
 
prevChar() - Method in interface org.jline.reader.Buffer
Returns the character before the current cursor position.
prevChar() - Method in class org.jline.reader.impl.BufferImpl
 
previous() - Method in interface org.jline.reader.History
Move the pointer to the previous element in the buffer.
previous() - Method in class org.jline.reader.impl.history.DefaultHistory
Moves the history cursor to the previous (older) entry.
printAbove(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
printAbove(String) - Method in interface org.jline.reader.LineReader
Prints a line above the prompt and redraw everything.
printAbove(AttributedString) - Method in class org.jline.reader.impl.LineReaderImpl
 
printAbove(AttributedString) - Method in interface org.jline.reader.LineReader
Prints a string before the prompt and redraw everything.
PrintAboveWriter - Class in org.jline.reader
Redirects a Writer to a LineReader's LineReader.printAbove(String) method, which draws output above the current prompt / input line.
PrintAboveWriter(LineReader) - Constructor for class org.jline.reader.PrintAboveWriter
 
prompt - Variable in class org.jline.reader.impl.LineReaderImpl
 
PROP_SUPPORT_PARSEDLINE - Static variable in interface org.jline.reader.LineReader
System property that can be set to avoid a warning being logged when using a Parser which does not return CompletingParsedLine objects.
purge() - Method in interface org.jline.reader.History
Purge history.
purge() - Method in class org.jline.reader.impl.history.DefaultHistory
Clears the history and deletes the history file.
pushBackChar - Variable in class org.jline.keymap.BindingReader
Stack for pushing back characters that need to be re-read
PUT_REPLACE_SELECTION - Static variable in interface org.jline.reader.LineReader
 
putString(CharSequence) - Method in class org.jline.reader.impl.LineReaderImpl
Write out the specified string to the buffer and the output stream.

Q

quit() - Method in class org.jline.reader.impl.LineReaderImpl
 
quoteChars(char[]) - Method in class org.jline.reader.impl.DefaultParser
Sets the quote characters.
QUOTED_INSERT - Static variable in interface org.jline.reader.LineReader
 
quotedInsert() - Method in class org.jline.reader.impl.LineReaderImpl
 

R

range(String) - Static method in class org.jline.keymap.KeyMap
Generates a collection of key sequences from a range specification.
rawWordCursor() - Method in interface org.jline.reader.CompletingParsedLine
Returns the cursor position within the raw (unprocessed) current word.
rawWordCursor() - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
rawWordLength() - Method in interface org.jline.reader.CompletingParsedLine
Returns the length of the raw (unprocessed) current word.
rawWordLength() - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
read(Path, boolean) - Method in interface org.jline.reader.History
Read history from the file.
read(Path, boolean) - Method in class org.jline.reader.impl.history.DefaultHistory
Reads history entries from the specified file and adds them to the current history.
READ_COMMAND - Static variable in interface org.jline.reader.LineReader
 
readBinding(KeyMap<Binding>) - Method in class org.jline.reader.impl.LineReaderImpl
Read from the input stream and decode an operation from the key map.
readBinding(KeyMap<Binding>, KeyMap<Binding>) - Method in class org.jline.reader.impl.LineReaderImpl
 
readBinding(KeyMap<T>) - Method in class org.jline.keymap.BindingReader
Read from the input stream and decode an operation from the key map.
readBinding(KeyMap<T>, KeyMap<T>) - Method in class org.jline.keymap.BindingReader
Reads a key binding from the input stream using the specified KeyMaps.
readBinding(KeyMap<T>, KeyMap<T>, boolean) - Method in class org.jline.keymap.BindingReader
Reads a key binding from the input stream using the specified KeyMaps.
readCharacter() - Method in class org.jline.keymap.BindingReader
Reads a single character (Unicode code point) from the input stream.
readCharacter() - Method in class org.jline.reader.impl.LineReaderImpl
Read a character from the terminal.
readCharacterBuffered() - Method in class org.jline.keymap.BindingReader
Reads a single character (Unicode code point) from the input stream with buffering.
reader - Variable in class org.jline.keymap.BindingReader
The non-blocking reader used to read input characters
ReaderUtils - Class in org.jline.reader.impl
Utility methods for LineReader implementations.
reading - Variable in class org.jline.reader.impl.LineReaderImpl
 
readLine() - Method in class org.jline.reader.impl.LineReaderImpl
Read the next line and return the contents of the buffer.
readLine() - Method in interface org.jline.reader.LineReader
Read the next line and return the contents of the buffer.
readLine(Character) - Method in class org.jline.reader.impl.LineReaderImpl
Read the next line with the specified character mask.
readLine(Character) - Method in interface org.jline.reader.LineReader
Read the next line with the specified character mask.
readLine(String) - Method in class org.jline.reader.impl.LineReaderImpl
Read a line from the in InputStream, and return the line (without any trailing newlines).
readLine(String) - Method in interface org.jline.reader.LineReader
Read the next line with the specified prompt.
readLine(String, Character) - Method in class org.jline.reader.impl.LineReaderImpl
Read a line from the in InputStream, and return the line (without any trailing newlines).
readLine(String, Character) - Method in interface org.jline.reader.LineReader
Read a line from the in InputStream, and return the line (without any trailing newlines).
readLine(String, Character, String) - Method in class org.jline.reader.impl.LineReaderImpl
Read a line from the in InputStream, and return the line (without any trailing newlines).
readLine(String, Character, String) - Method in interface org.jline.reader.LineReader
Read a line from the in InputStream, and return the line (without any trailing newlines).
readLine(String, String, Character, String) - Method in class org.jline.reader.impl.LineReaderImpl
Read a line from the in InputStream, and return the line (without any trailing newlines).
readLine(String, String, Character, String) - Method in interface org.jline.reader.LineReader
Read a line from the in InputStream, and return the line (without any trailing newlines).
readLine(String, String, MaskingCallback, String) - Method in class org.jline.reader.impl.LineReaderImpl
Read a line from the in InputStream, and return the line (without any trailing newlines).
readLine(String, String, MaskingCallback, String) - Method in interface org.jline.reader.LineReader
Read a line from the in InputStream, and return the line (without any trailing newlines).
readMouseEvent() - Method in class org.jline.reader.impl.LineReaderImpl
 
readMouseEvent() - Method in interface org.jline.reader.LineReader
Read a mouse event when the InfoCmp.Capability.key_mouse sequence has just been read on the input stream.
readStringUntil(String) - Method in class org.jline.keymap.BindingReader
Reads characters from the input until a specific sequence is encountered.
RECOGNIZE_EXACT - org.jline.reader.LineReader.Option
 
RECURSIVE_EDIT - Static variable in interface org.jline.reader.LineReader
 
redisplay() - Method in class org.jline.reader.impl.LineReaderImpl
 
redisplay(boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
REDISPLAY - Static variable in interface org.jline.reader.LineReader
 
redo() - Method in class org.jline.reader.impl.LineReaderImpl
 
redo() - Method in class org.jline.reader.impl.UndoTree
 
REDO - Static variable in interface org.jline.reader.LineReader
 
REDRAW_LINE - Static variable in interface org.jline.reader.LineReader
 
redrawLine() - Method in class org.jline.reader.impl.LineReaderImpl
Clear the line and redraw it.
Reference - Class in org.jline.reader
A reference to a Widget by name.
Reference(String) - Constructor for class org.jline.reader.Reference
 
refresh(LineReader) - Method in interface org.jline.reader.Highlighter
Refreshes the highlighter's configuration.
REGEX_COMMAND - Static variable in interface org.jline.reader.Parser
 
REGEX_VARIABLE - Static variable in interface org.jline.reader.Parser
 
regexCommand(String) - Method in class org.jline.reader.impl.DefaultParser
Sets the regular expression for identifying commands.
regexVariable(String) - Method in class org.jline.reader.impl.DefaultParser
Sets the regular expression for identifying variables.
regionActive - Variable in class org.jline.reader.impl.LineReaderImpl
 
regionMark - Variable in class org.jline.reader.impl.LineReaderImpl
Region state
REMOVE_SUFFIX_CHARS - Static variable in interface org.jline.reader.LineReader
 
repeatCount - Variable in class org.jline.reader.impl.LineReaderImpl
 
reset(boolean) - Method in class org.jline.reader.impl.CompletionMatcherImpl
 
resetIndex() - Method in interface org.jline.reader.History
Reset index after remove
resetIndex() - Method in class org.jline.reader.impl.history.DefaultHistory
 
resetLastKill() - Method in class org.jline.reader.impl.KillRing
Resets the last-kill state.
resetLastYank() - Method in class org.jline.reader.impl.KillRing
Resets the last-yank state.
REVERSE_MENU_COMPLETE - Static variable in interface org.jline.reader.LineReader
 
reverseIterator() - Method in interface org.jline.reader.History
 
reverseIterator(int) - Method in interface org.jline.reader.History
 
rightPrompt - Variable in class org.jline.reader.impl.LineReaderImpl
 
ROUND - org.jline.reader.impl.DefaultParser.Bracket
 
run() - Method in interface org.jline.reader.Editor
Runs the editor process.
runMacro(String) - Method in class org.jline.keymap.BindingReader
Runs a macro by pushing its characters into the input buffer.
runMacro(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
runMacro(String) - Method in interface org.jline.reader.LineReader
Push back a key sequence that will be later consumed by the line reader.

S

safe() - Method in class org.jline.reader.impl.LineReaderImpl
 
SAFE - Static variable in interface org.jline.reader.LineReader
 
save() - Method in interface org.jline.reader.History
Save history.
save() - Method in class org.jline.reader.impl.history.DefaultHistory
Saves the history to the default history file.
SEARCH_TERMINATORS - Static variable in interface org.jline.reader.LineReader
 
searchBackward - Variable in class org.jline.reader.impl.LineReaderImpl
 
searchBackwards(String) - Method in class org.jline.reader.impl.LineReaderImpl
Search backwards in history from the current position.
searchBackwards(String, int) - Method in class org.jline.reader.impl.LineReaderImpl
Search backward in history from a given position.
searchBackwards(String, int, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
searchBackwards(History, String, int, boolean) - Method in class org.jline.reader.impl.DefaultExpander
 
searchBuffer - Variable in class org.jline.reader.impl.LineReaderImpl
 
searchFailing - Variable in class org.jline.reader.impl.LineReaderImpl
 
searchForwards(String) - Method in class org.jline.reader.impl.LineReaderImpl
Search forwards in history from the current position.
searchForwards(String, int) - Method in class org.jline.reader.impl.LineReaderImpl
Search forward in history from a given position.
searchForwards(String, int, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
searchIndex - Variable in class org.jline.reader.impl.LineReaderImpl
 
searchTerm - Variable in class org.jline.reader.impl.LineReaderImpl
 
SECONDARY_PROMPT - org.jline.reader.Parser.ParseContext
Called when we need to update the secondary prompts.
SECONDARY_PROMPT_PATTERN - Static variable in interface org.jline.reader.LineReader
Set the template for prompts for secondary (continuation) lines.
SELF_INSERT - Static variable in interface org.jline.reader.LineReader
 
SELF_INSERT_UNMETA - Static variable in interface org.jline.reader.LineReader
 
selfInsert() - Method in class org.jline.reader.impl.LineReaderImpl
 
selfInsertUnmeta() - Method in class org.jline.reader.impl.LineReaderImpl
 
SEND_BREAK - Static variable in interface org.jline.reader.LineReader
 
sendBreak() - Method in class org.jline.reader.impl.LineReaderImpl
 
SET_LOCAL_HISTORY - Static variable in interface org.jline.reader.LineReader
 
SET_MARK_COMMAND - Static variable in interface org.jline.reader.LineReader
 
setAmbiguousTimeout(long) - Method in class org.jline.keymap.KeyMap
Sets the timeout for ambiguous key bindings in milliseconds.
setAutosuggestion(LineReader.SuggestionType) - Method in class org.jline.reader.impl.LineReaderImpl
 
setAutosuggestion(LineReader.SuggestionType) - Method in interface org.jline.reader.LineReader
Sets the type of auto-suggestion to use.
setBlockCommentDelims(DefaultParser.BlockCommentDelims) - Method in class org.jline.reader.impl.DefaultParser
Sets the block comment delimiters.
setBuffer(String) - Method in class org.jline.reader.impl.LineReaderImpl
Set the current buffer's content to the specified String.
setBuffer(Buffer) - Method in class org.jline.reader.impl.LineReaderImpl
 
setCommandGroup(int) - Method in class org.jline.reader.impl.DefaultParser
Sets the command group for the regular expression.
setCompleter(Completer) - Method in class org.jline.reader.impl.LineReaderImpl
Set the completer.
setCompletionMatcher(CompletionMatcher) - Method in class org.jline.reader.impl.LineReaderImpl
 
setEofOnEscapedNewLine(boolean) - Method in class org.jline.reader.impl.DefaultParser
Sets whether EOF should be returned on escaped newlines.
setEofOnUnclosedBracket(DefaultParser.Bracket...) - Method in class org.jline.reader.impl.DefaultParser
Sets the bracket types that should trigger EOF on unclosed brackets.
setEofOnUnclosedQuote(boolean) - Method in class org.jline.reader.impl.DefaultParser
Sets whether EOF should be returned on unclosed quotes.
setErrorIndex(int) - Method in interface org.jline.reader.Highlighter
Sets a specific character position in the buffer to be highlighted as an error.
setErrorIndex(int) - Method in class org.jline.reader.impl.DefaultHighlighter
 
setErrorPattern(Pattern) - Method in interface org.jline.reader.Highlighter
Sets a regular expression pattern that identifies errors to be highlighted.
setErrorPattern(Pattern) - Method in class org.jline.reader.impl.DefaultHighlighter
 
setEscapeChars(char[]) - Method in class org.jline.reader.impl.DefaultParser
Sets the escape characters.
setExpander(Expander) - Method in class org.jline.reader.impl.LineReaderImpl
 
setHighlighter(Highlighter) - Method in class org.jline.reader.impl.LineReaderImpl
 
setHistory(History) - Method in class org.jline.reader.impl.LineReaderImpl
 
setKeyMap(String) - Method in class org.jline.reader.impl.LineReaderImpl
Sets the current keymap by name.
setKeyMap(String) - Method in interface org.jline.reader.LineReader
Sets the active key map by name.
setLineCommentDelims(String[]) - Method in class org.jline.reader.impl.DefaultParser
Sets the line comment delimiters.
setMarkCommand() - Method in class org.jline.reader.impl.LineReaderImpl
 
setNomatch(T) - Method in class org.jline.keymap.KeyMap
Sets the binding for input sequences that don't match any known binding.
setOpt(LineReader.Option) - Method in class org.jline.reader.impl.LineReaderImpl
 
setOpt(LineReader.Option) - Method in interface org.jline.reader.LineReader
Sets an option to true.
setParser(Parser) - Method in class org.jline.reader.impl.LineReaderImpl
 
setPrompt(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
setQuoteChars(char[]) - Method in class org.jline.reader.impl.DefaultParser
Sets the quote characters.
setRegexCommand(String) - Method in class org.jline.reader.impl.DefaultParser
Sets the regular expression for identifying commands.
setRegexVariable(String) - Method in class org.jline.reader.impl.DefaultParser
Sets the regular expression for identifying variables.
setRestricted(boolean) - Method in interface org.jline.reader.Editor
Sets whether the editor should run in restricted mode.
setRightPrompt(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
setStrict(boolean) - Method in class org.jline.reader.impl.completer.ArgumentCompleter
If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed.
setStrictCommand(boolean) - Method in class org.jline.reader.impl.completer.ArgumentCompleter
If true, a completion at argument index N will only succeed if all the completions from 1-(N-1) also succeed.
setTailTip(String) - Method in class org.jline.reader.impl.LineReaderImpl
 
setTailTip(String) - Method in interface org.jline.reader.LineReader
Sets the tail tip text.
setUnicode(T) - Method in class org.jline.keymap.KeyMap
Sets the binding for Unicode characters that don't have explicit bindings.
setVariable(String, Object) - Method in class org.jline.reader.impl.LineReaderImpl
 
setVariable(String, Object) - Method in interface org.jline.reader.LineReader
Sets a variable in the LineReader.
SimpleMaskingCallback - Class in org.jline.reader.impl
Simple MaskingCallback that will replace all the characters in the line with the given mask.
SimpleMaskingCallback(Character) - Constructor for class org.jline.reader.impl.SimpleMaskingCallback
 
simpleMatcher(Predicate<String>) - Method in class org.jline.reader.impl.CompletionMatcherImpl
 
size - Variable in class org.jline.reader.impl.LineReaderImpl
 
size() - Method in interface org.jline.reader.History
Returns the number of items in the history.
size() - Method in class org.jline.reader.impl.history.DefaultHistory
 
skipRedisplay - Variable in class org.jline.reader.impl.LineReaderImpl
 
smallTerminalOffset - Variable in class org.jline.reader.impl.LineReaderImpl
 
sort() - Method in class org.jline.reader.Candidate
Integer used to override default sort logic.
SPELL_WORD - Static variable in interface org.jline.reader.LineReader
 
SPLIT_LINE - org.jline.reader.Parser.ParseContext
Parsed words will have all characters present in input line including quotes and escape chars.
SPLIT_UNDO - Static variable in interface org.jline.reader.LineReader
 
spliterator() - Method in class org.jline.reader.impl.history.DefaultHistory
 
SQUARE - org.jline.reader.impl.DefaultParser.Bracket
 
startedReading - Variable in class org.jline.reader.impl.LineReaderImpl
 
state - Variable in class org.jline.reader.impl.LineReaderImpl
 
StringsCompleter - Class in org.jline.reader.impl.completer
Completer for a set of strings.
StringsCompleter() - Constructor for class org.jline.reader.impl.completer.StringsCompleter
 
StringsCompleter(Iterable<String>) - Constructor for class org.jline.reader.impl.completer.StringsCompleter
 
StringsCompleter(String...) - Constructor for class org.jline.reader.impl.completer.StringsCompleter
 
StringsCompleter(Collection<Candidate>) - Constructor for class org.jline.reader.impl.completer.StringsCompleter
 
StringsCompleter(Supplier<Collection<String>>) - Constructor for class org.jline.reader.impl.completer.StringsCompleter
 
StringsCompleter(Candidate...) - Constructor for class org.jline.reader.impl.completer.StringsCompleter
 
stringsSupplier - Variable in class org.jline.reader.impl.completer.StringsCompleter
 
substring(int) - Method in interface org.jline.reader.Buffer
Returns a substring of the buffer from the specified start position to the end.
substring(int) - Method in class org.jline.reader.impl.BufferImpl
 
substring(int, int) - Method in interface org.jline.reader.Buffer
Returns a substring of the buffer from the specified start position to the specified end position.
substring(int, int) - Method in class org.jline.reader.impl.BufferImpl
 
suffix() - Method in class org.jline.reader.Candidate
The suffix is added when this candidate is displayed.
SUGGESTIONS_MIN_BUFFER_SIZE - Static variable in interface org.jline.reader.LineReader
Min buffer size for tab auto-suggestions.
switchCase(int) - Method in class org.jline.reader.impl.LineReaderImpl
 
SyntaxError - Exception in org.jline.reader
Exception thrown when a syntax error is encountered during parsing.
SyntaxError(int, int, String) - Constructor for exception org.jline.reader.SyntaxError
 
SYSTEM_PROPERTY_PREFIX - Static variable in interface org.jline.reader.LineReader
Prefix to automatically delegate variables to system properties
SystemCompleter - Class in org.jline.reader.impl.completer
Completer which contains multiple completers and aggregates them together.
SystemCompleter() - Constructor for class org.jline.reader.impl.completer.SystemCompleter
 

T

TAB_WIDTH - Static variable in class org.jline.reader.impl.LineReaderImpl
TAB_WIDTH - Static variable in interface org.jline.reader.LineReader
Number of spaces to display a tabulation, the default is 4.
TAIL_TIP - org.jline.reader.LineReader.SuggestionType
Prepare command line suggestions using command completer data and/or command positional argument descriptions.
tailTip - Variable in class org.jline.reader.impl.LineReaderImpl
 
terminal - Variable in class org.jline.reader.impl.LineReaderImpl
The terminal to use
terminal(Terminal) - Method in class org.jline.reader.LineReaderBuilder
Sets the terminal to be used by the LineReader.
time() - Method in interface org.jline.reader.History.Entry
Returns the timestamp when this entry was added to the history.
time() - Method in class org.jline.reader.impl.history.DefaultHistory.EntryImpl
 
toColumns(Object, int, int, AttributedStringBuilder, Candidate, String, boolean, boolean, int[]) - Method in class org.jline.reader.impl.LineReaderImpl
 
toColumns(List<Object>, Candidate, String, Function<String, Integer>, int, boolean) - Method in class org.jline.reader.impl.LineReaderImpl
 
toString() - Method in interface org.jline.reader.Buffer
 
toString() - Method in class org.jline.reader.Candidate
 
toString() - Method in class org.jline.reader.impl.BufferImpl
 
toString() - Method in class org.jline.reader.impl.completer.AggregateCompleter
 
toString() - Method in class org.jline.reader.impl.completer.StringsCompleter
 
toString() - Method in class org.jline.reader.impl.history.DefaultHistory.EntryImpl
 
toString() - Method in class org.jline.reader.impl.history.DefaultHistory
 
toString() - Method in class org.jline.reader.Macro
 
toString() - Method in class org.jline.reader.Reference
 
translate(String) - Static method in class org.jline.keymap.KeyMap
Translates a string containing special escape sequences into the actual key sequence.
TRANSPOSE_CHARS - Static variable in interface org.jline.reader.LineReader
 
TRANSPOSE_WORDS - Static variable in interface org.jline.reader.LineReader
 
transposeChars() - Method in class org.jline.reader.impl.LineReaderImpl
Performs character transpose.
transposeWords() - Method in class org.jline.reader.impl.LineReaderImpl
 
trimHistory(Path, int) - Method in class org.jline.reader.impl.history.DefaultHistory
Trims the history file to the specified maximum number of entries.
typoMatcher(String, int, boolean, String) - Method in class org.jline.reader.impl.CompletionMatcherImpl
 

U

unbind(CharSequence) - Method in class org.jline.keymap.KeyMap
Unbinds a key sequence.
unbind(CharSequence...) - Method in class org.jline.keymap.KeyMap
 
UNDEFINED_KEY - Static variable in interface org.jline.reader.LineReader
 
undefinedKey() - Method in class org.jline.reader.impl.LineReaderImpl
 
undo - Variable in class org.jline.reader.impl.LineReaderImpl
 
undo() - Method in class org.jline.reader.impl.LineReaderImpl
 
undo() - Method in class org.jline.reader.impl.UndoTree
 
UNDO - Static variable in interface org.jline.reader.LineReader
 
UndoTree<T> - Class in org.jline.reader.impl
Provides undo/redo functionality for the LineReader.
UndoTree(Consumer<T>) - Constructor for class org.jline.reader.impl.UndoTree
 
universal - Variable in class org.jline.reader.impl.LineReaderImpl
 
UNIVERSAL_ARGUMENT - Static variable in interface org.jline.reader.LineReader
 
universalArgument() - Method in class org.jline.reader.impl.LineReaderImpl
 
unsetOpt(LineReader.Option) - Method in class org.jline.reader.impl.LineReaderImpl
 
unsetOpt(LineReader.Option) - Method in interface org.jline.reader.LineReader
Sets an option to false.
UNSPECIFIED - org.jline.reader.Parser.ParseContext
 
up() - Method in interface org.jline.reader.Buffer
Moves the cursor up one line while maintaining the same column position if possible.
up() - Method in class org.jline.reader.impl.BufferImpl
 
UP_CASE_WORD - Static variable in interface org.jline.reader.LineReader
 
UP_HISTORY - Static variable in interface org.jline.reader.LineReader
 
UP_LINE - Static variable in interface org.jline.reader.LineReader
 
UP_LINE_OR_HISTORY - Static variable in interface org.jline.reader.LineReader
 
UP_LINE_OR_SEARCH - Static variable in interface org.jline.reader.LineReader
 
upCaseWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
upHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
upLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
upLineOrHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
upLineOrSearch() - Method in class org.jline.reader.impl.LineReaderImpl
 
upToCursor() - Method in interface org.jline.reader.Buffer
Returns a substring of the buffer from the beginning to the current cursor position.
upToCursor() - Method in class org.jline.reader.impl.BufferImpl
 
USE_FORWARD_SLASH - org.jline.reader.LineReader.Option
FileNameCompleter: Use '/' character as a file directory separator
UserInterruptException - Exception in org.jline.reader
This exception is thrown by LineReader.readLine() when user interrupt handling is enabled and the user types the interrupt character (ctrl-C).
UserInterruptException(String) - Constructor for exception org.jline.reader.UserInterruptException
 
UserInterruptException(Throwable) - Constructor for exception org.jline.reader.UserInterruptException
 

V

validCommandName(String) - Method in class org.jline.reader.impl.DefaultParser
 
validCommandName(String) - Method in interface org.jline.reader.Parser
 
validVariableName(String) - Method in class org.jline.reader.impl.DefaultParser
 
validVariableName(String) - Method in interface org.jline.reader.Parser
 
value() - Method in class org.jline.reader.Candidate
The value that will be used for the actual completion.
valueOf(String) - Static method in enum org.jline.reader.impl.DefaultParser.Bracket
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jline.reader.impl.LineReaderImpl.BellType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jline.reader.impl.LineReaderImpl.CompletionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jline.reader.impl.LineReaderImpl.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jline.reader.impl.LineReaderImpl.ViMoveMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jline.reader.LineReader.Option
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jline.reader.LineReader.RegionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jline.reader.LineReader.SuggestionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jline.reader.Parser.ParseContext
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jline.reader.impl.DefaultParser.Bracket
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jline.reader.impl.LineReaderImpl.BellType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jline.reader.impl.LineReaderImpl.CompletionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jline.reader.impl.LineReaderImpl.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jline.reader.impl.LineReaderImpl.ViMoveMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jline.reader.LineReader.Option
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jline.reader.LineReader.RegionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jline.reader.LineReader.SuggestionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jline.reader.Parser.ParseContext
Returns an array containing the constants of this enum type, in the order they are declared.
variable(String, Object) - Method in class org.jline.reader.impl.LineReaderImpl
 
variable(String, Object) - Method in interface org.jline.reader.LineReader
Sets a variable in the LineReader and returns the LineReader for method chaining.
variable(String, Object) - Method in class org.jline.reader.LineReaderBuilder
 
variables - Variable in class org.jline.reader.impl.LineReaderImpl
 
variables(Map<String, Object>) - Method in class org.jline.reader.LineReaderBuilder
 
VI_ADD_EOL - Static variable in interface org.jline.reader.LineReader
 
VI_ADD_NEXT - Static variable in interface org.jline.reader.LineReader
 
VI_BACKWARD_BLANK_WORD - Static variable in interface org.jline.reader.LineReader
 
VI_BACKWARD_BLANK_WORD_END - Static variable in interface org.jline.reader.LineReader
 
VI_BACKWARD_CHAR - Static variable in interface org.jline.reader.LineReader
 
VI_BACKWARD_DELETE_CHAR - Static variable in interface org.jline.reader.LineReader
 
VI_BACKWARD_KILL_WORD - Static variable in interface org.jline.reader.LineReader
 
VI_BACKWARD_WORD - Static variable in interface org.jline.reader.LineReader
 
VI_BACKWARD_WORD_END - Static variable in interface org.jline.reader.LineReader
 
VI_BEGINNING_OF_LINE - Static variable in interface org.jline.reader.LineReader
 
VI_CHANGE - Static variable in interface org.jline.reader.LineReader
 
VI_CHANGE_EOL - Static variable in interface org.jline.reader.LineReader
 
VI_CHANGE_WHOLE_LINE - Static variable in interface org.jline.reader.LineReader
 
VI_CMD_MODE - Static variable in interface org.jline.reader.LineReader
 
VI_DELETE - Static variable in interface org.jline.reader.LineReader
 
VI_DELETE_CHAR - Static variable in interface org.jline.reader.LineReader
 
VI_DIGIT_OR_BEGINNING_OF_LINE - Static variable in interface org.jline.reader.LineReader
 
VI_DOWN_LINE_OR_HISTORY - Static variable in interface org.jline.reader.LineReader
 
VI_END_OF_LINE - Static variable in interface org.jline.reader.LineReader
 
VI_FETCH_HISTORY - Static variable in interface org.jline.reader.LineReader
 
VI_FIND_NEXT_CHAR - Static variable in interface org.jline.reader.LineReader
 
VI_FIND_NEXT_CHAR_SKIP - Static variable in interface org.jline.reader.LineReader
 
VI_FIND_PREV_CHAR - Static variable in interface org.jline.reader.LineReader
 
VI_FIND_PREV_CHAR_SKIP - Static variable in interface org.jline.reader.LineReader
 
VI_FIRST_NON_BLANK - Static variable in interface org.jline.reader.LineReader
 
VI_FORWARD_BLANK_WORD - Static variable in interface org.jline.reader.LineReader
 
VI_FORWARD_BLANK_WORD_END - Static variable in interface org.jline.reader.LineReader
 
VI_FORWARD_CHAR - Static variable in interface org.jline.reader.LineReader
 
VI_FORWARD_WORD - Static variable in interface org.jline.reader.LineReader
 
VI_FORWARD_WORD_END - Static variable in interface org.jline.reader.LineReader
 
VI_GOTO_COLUMN - Static variable in interface org.jline.reader.LineReader
 
VI_HISTORY_SEARCH_BACKWARD - Static variable in interface org.jline.reader.LineReader
 
VI_HISTORY_SEARCH_FORWARD - Static variable in interface org.jline.reader.LineReader
 
VI_INSERT - Static variable in interface org.jline.reader.LineReader
 
VI_INSERT_BOL - Static variable in interface org.jline.reader.LineReader
 
VI_INSERT_COMMENT - Static variable in interface org.jline.reader.LineReader
 
VI_JOIN - Static variable in interface org.jline.reader.LineReader
 
VI_KILL_EOL - Static variable in interface org.jline.reader.LineReader
 
VI_KILL_LINE - Static variable in interface org.jline.reader.LineReader
 
VI_MATCH_BRACKET - Static variable in interface org.jline.reader.LineReader
 
VI_OPEN_LINE_ABOVE - Static variable in interface org.jline.reader.LineReader
 
VI_OPEN_LINE_BELOW - Static variable in interface org.jline.reader.LineReader
 
VI_OPER_SWAP_CASE - Static variable in interface org.jline.reader.LineReader
 
VI_PUT_AFTER - Static variable in interface org.jline.reader.LineReader
 
VI_PUT_BEFORE - Static variable in interface org.jline.reader.LineReader
 
VI_QUOTED_INSERT - Static variable in interface org.jline.reader.LineReader
 
VI_REPEAT_CHANGE - Static variable in interface org.jline.reader.LineReader
 
VI_REPEAT_FIND - Static variable in interface org.jline.reader.LineReader
 
VI_REPEAT_SEARCH - Static variable in interface org.jline.reader.LineReader
 
VI_REPLACE - Static variable in interface org.jline.reader.LineReader
 
VI_REPLACE_CHARS - Static variable in interface org.jline.reader.LineReader
 
VI_REV_REPEAT_FIND - Static variable in interface org.jline.reader.LineReader
 
VI_REV_REPEAT_SEARCH - Static variable in interface org.jline.reader.LineReader
 
VI_SET_BUFFER - Static variable in interface org.jline.reader.LineReader
 
VI_SUBSTITUTE - Static variable in interface org.jline.reader.LineReader
 
VI_SWAP_CASE - Static variable in interface org.jline.reader.LineReader
 
VI_UNDO_CHANGE - Static variable in interface org.jline.reader.LineReader
 
VI_UP_LINE_OR_HISTORY - Static variable in interface org.jline.reader.LineReader
 
VI_YANK - Static variable in interface org.jline.reader.LineReader
 
VI_YANK_EOL - Static variable in interface org.jline.reader.LineReader
 
VI_YANK_WHOLE_LINE - Static variable in interface org.jline.reader.LineReader
 
viAddEol() - Method in class org.jline.reader.impl.LineReaderImpl
 
viAddNext() - Method in class org.jline.reader.impl.LineReaderImpl
 
viBackwardBlankWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
viBackwardBlankWordEnd() - Method in class org.jline.reader.impl.LineReaderImpl
 
viBackwardChar() - Method in class org.jline.reader.impl.LineReaderImpl
 
viBackwardDeleteChar() - Method in class org.jline.reader.impl.LineReaderImpl
Deletes the previous character from the cursor position
viBackwardKillWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
viBackwardWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
viBackwardWordEnd() - Method in class org.jline.reader.impl.LineReaderImpl
 
viBeginningOfLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
viChange() - Method in class org.jline.reader.impl.LineReaderImpl
 
viChange(int, int) - Method in class org.jline.reader.impl.LineReaderImpl
 
viChangeEol() - Method in class org.jline.reader.impl.LineReaderImpl
 
viChangeWholeLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
viCmd() - Method in class org.jline.reader.impl.LineReaderImpl
 
VICMD - Static variable in interface org.jline.reader.LineReader
 
viCmdMode() - Method in class org.jline.reader.impl.LineReaderImpl
 
viDelete() - Method in class org.jline.reader.impl.LineReaderImpl
 
viDeleteChangeYankToRemap(String) - Method in class org.jline.reader.impl.LineReaderImpl
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.
viDeleteChar() - Method in class org.jline.reader.impl.LineReaderImpl
Deletes the character you are sitting on and sucks the rest of the line in from the right.
viDeleteTo(int, int) - Method in class org.jline.reader.impl.LineReaderImpl
 
viDigitOrBeginningOfLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
viDownLineOrHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
viEndOfLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
viFindNextChar() - Method in class org.jline.reader.impl.LineReaderImpl
 
viFindNextCharSkip() - Method in class org.jline.reader.impl.LineReaderImpl
 
viFindPrevChar() - Method in class org.jline.reader.impl.LineReaderImpl
 
viFindPrevCharSkip() - Method in class org.jline.reader.impl.LineReaderImpl
 
viFirstNonBlank() - Method in class org.jline.reader.impl.LineReaderImpl
 
viForwardBlankWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
viForwardBlankWordEnd() - Method in class org.jline.reader.impl.LineReaderImpl
 
viForwardChar() - Method in class org.jline.reader.impl.LineReaderImpl
 
viForwardWord() - Method in class org.jline.reader.impl.LineReaderImpl
 
viForwardWordEnd() - Method in class org.jline.reader.impl.LineReaderImpl
 
viHistorySearchBackward() - Method in class org.jline.reader.impl.LineReaderImpl
 
viHistorySearchForward() - Method in class org.jline.reader.impl.LineReaderImpl
Implements vi search ("/" or "?").
VIINS - Static variable in interface org.jline.reader.LineReader
 
viInsert() - Method in class org.jline.reader.impl.LineReaderImpl
 
viInsertBol() - Method in class org.jline.reader.impl.LineReaderImpl
 
viInsertComment() - Method in class org.jline.reader.impl.LineReaderImpl
 
viInsertion() - Method in class org.jline.reader.impl.LineReaderImpl
 
viJoin() - Method in class org.jline.reader.impl.LineReaderImpl
 
viKillEol() - Method in class org.jline.reader.impl.LineReaderImpl
 
viKillWholeLine() - Method in class org.jline.reader.impl.LineReaderImpl
 
viMatchBracket() - Method in class org.jline.reader.impl.LineReaderImpl
 
viMoveMode - Variable in class org.jline.reader.impl.LineReaderImpl
 
viOpenLineAbove() - Method in class org.jline.reader.impl.LineReaderImpl
 
viOpenLineBelow() - Method in class org.jline.reader.impl.LineReaderImpl
 
viOpp() - Method in class org.jline.reader.impl.LineReaderImpl
 
VIOPP - Static variable in interface org.jline.reader.LineReader
 
viPutAfter() - Method in class org.jline.reader.impl.LineReaderImpl
Pasts the yank buffer to the right of the current cursor position and moves the cursor to the end of the pasted region.
viPutBefore() - Method in class org.jline.reader.impl.LineReaderImpl
 
viRepeatFind() - Method in class org.jline.reader.impl.LineReaderImpl
 
viRepeatSearch() - Method in class org.jline.reader.impl.LineReaderImpl
 
viReplaceChars() - Method in class org.jline.reader.impl.LineReaderImpl
Implements the vi change character command (in move-mode "r" followed by the character to change to).
viRevRepeatFind() - Method in class org.jline.reader.impl.LineReaderImpl
 
viRevRepeatSearch() - Method in class org.jline.reader.impl.LineReaderImpl
 
VISIBLE - org.jline.reader.impl.LineReaderImpl.BellType
 
visual() - Method in class org.jline.reader.impl.LineReaderImpl
 
VISUAL - Static variable in interface org.jline.reader.LineReader
 
VISUAL_LINE_MODE - Static variable in interface org.jline.reader.LineReader
 
VISUAL_MODE - Static variable in interface org.jline.reader.LineReader
 
visualLineMode() - Method in class org.jline.reader.impl.LineReaderImpl
 
visualMode() - Method in class org.jline.reader.impl.LineReaderImpl
 
viSwapCase() - Method in class org.jline.reader.impl.LineReaderImpl
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.
viUpLineOrHistory() - Method in class org.jline.reader.impl.LineReaderImpl
 
viYankTo() - Method in class org.jline.reader.impl.LineReaderImpl
 
viYankTo(int, int) - Method in class org.jline.reader.impl.LineReaderImpl
Implement the "vi" yank-to operation.
viYankWholeLine() - Method in class org.jline.reader.impl.LineReaderImpl
 

W

WHAT_CURSOR_POSITION - Static variable in interface org.jline.reader.LineReader
 
whatCursorPosition() - Method in class org.jline.reader.impl.LineReaderImpl
 
Widget - Interface in org.jline.reader
A Widget represents an action that can be bound to a key sequence in the LineReader.
widgets - Variable in class org.jline.reader.impl.LineReaderImpl
 
word() - Method in class org.jline.reader.impl.completer.ArgumentCompleter.ArgumentLine
 
word() - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
word() - Method in interface org.jline.reader.ParsedLine
The current word being completed.
WORDCHARS - Static variable in interface org.jline.reader.LineReader
 
wordCursor() - Method in class org.jline.reader.impl.completer.ArgumentCompleter.ArgumentLine
 
wordCursor() - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
wordCursor() - Method in interface org.jline.reader.ParsedLine
The cursor position within the current word.
wordIndex() - Method in class org.jline.reader.impl.completer.ArgumentCompleter.ArgumentLine
 
wordIndex() - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
wordIndex() - Method in interface org.jline.reader.ParsedLine
The index of the current word in the list of words.
words() - Method in class org.jline.reader.impl.completer.ArgumentCompleter.ArgumentLine
 
words() - Method in class org.jline.reader.impl.DefaultParser.ArgumentList
 
words() - Method in interface org.jline.reader.ParsedLine
The list of words.
wrap(ParsedLine) - Static method in class org.jline.reader.impl.LineReaderImpl
 
write(int) - Method in interface org.jline.reader.Buffer
Writes a character at the current cursor position and advances the cursor.
write(int) - Method in class org.jline.reader.impl.BufferImpl
Write the specific character into the buffer, setting the cursor position ahead one.
write(int, boolean) - Method in interface org.jline.reader.Buffer
Writes a character at the current cursor position and advances the cursor.
write(int, boolean) - Method in class org.jline.reader.impl.BufferImpl
Write the specific character into the buffer, setting the cursor position ahead one.
write(CharSequence) - Method in interface org.jline.reader.Buffer
Writes a string at the current cursor position and advances the cursor.
write(CharSequence) - Method in class org.jline.reader.impl.BufferImpl
Insert the specified chars into the buffer, setting the cursor to the end of the insertion point.
write(CharSequence, boolean) - Method in interface org.jline.reader.Buffer
Writes a string at the current cursor position and advances the cursor.
write(CharSequence, boolean) - Method in class org.jline.reader.impl.BufferImpl
 
write(Path, boolean) - Method in interface org.jline.reader.History
Write history to the file.
write(Path, boolean) - Method in class org.jline.reader.impl.history.DefaultHistory
Writes the history to the specified file, optionally replacing the existing file.

Y

yank() - Method in class org.jline.reader.impl.KillRing
Yanks a previously killed text.
yank() - Method in class org.jline.reader.impl.LineReaderImpl
 
YANK - org.jline.reader.impl.LineReaderImpl.ViMoveMode
 
YANK - Static variable in interface org.jline.reader.LineReader
 
YANK_POP - Static variable in interface org.jline.reader.LineReader
 
yankBuffer - Variable in class org.jline.reader.impl.LineReaderImpl
The vi yank buffer
yankPop() - Method in class org.jline.reader.impl.KillRing
Moves the pointer to the current slot back and returns the text in that position.
yankPop() - Method in class org.jline.reader.impl.LineReaderImpl
 

Z

zeroOut() - Method in interface org.jline.reader.Buffer
Clear any internal buffer.
zeroOut() - Method in class org.jline.reader.impl.BufferImpl
 
zeroOut() - Method in class org.jline.reader.impl.LineReaderImpl
 
zeroOut() - Method in interface org.jline.reader.LineReader
Clears any internal buffers and sensitive data.
A B C D E F G H I K L M N O P Q R S T U V W Y Z 
All Classes All Packages