All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description AggregateCompleter Completer which contains multiple completers and aggregates them together.ArgumentCompleter ACompleter
implementation that invokes a child completer using the appropriate separator argument.ArgumentCompleter.ArgumentLine A simple implementation of ParsedLine for argument completion.Binding Marker interface for objects that can be bound to key sequences in a KeyMap.BindingReader The BindingReader transforms incoming characters into key bindings.Buffer Represents the editable text buffer in the LineReader.BufferImpl Default implementation of theBuffer
interface.Candidate Represents a completion candidate for tab completion.Completer A completer is the mechanism by which tab-completion candidates will be resolved.CompletingParsedLine An extension ofParsedLine
that, being aware of the quoting and escaping rules of theParser
that produced it, knows if and how a completion candidate should be escaped/quoted.CompletionMatcher Interface for matching and filtering completion candidates.CompletionMatcherImpl Default implementation of theCompletionMatcher
interface.DefaultExpander Default implementation of theExpander
interface.DefaultHighlighter Default implementation of theHighlighter
interface.DefaultHistory Default implementation ofHistory
with file-based persistent storage.DefaultHistory.EntryImpl Default implementation of theHistory.Entry
interface.DefaultParser Default implementation of theParser
interface.DefaultParser.BlockCommentDelims Class representing block comment delimiters.DefaultParser.Bracket Enumeration of bracket types that can be used for EOF detection on unclosed brackets.Editor Interface for launching external editors from within a JLine application.EndOfFileException This exception is thrown byLineReader.readLine()
when user the user types ctrl-D).EnumCompleter Completer
forEnum
names.EOFError Exception thrown when parsing is incomplete due to unexpected end of input.Expander The Expander interface provides functionality for expanding special syntax in command lines.FileNameCompleter Deprecated. useorg.jline.builtins.Completers$FileNameCompleter
insteadHighlighter The Highlighter interface provides syntax highlighting functionality for the LineReader.History Console command history management interface.History.Entry Represents a single history entry containing a command line and its metadata.InputRC Handles inputrc configuration files for JLine.KeyMap<T> The KeyMap class maps keyboard input sequences to operations or actions.KillRing The kill ring class keeps killed text in a fixed size ring.LineReader Read lines from the console, with input editing.LineReader.Option LineReader.RegionType LineReader.SuggestionType LineReaderBuilder A builder for creating and configuringLineReader
instances.LineReaderImpl The default implementation of theLineReader
interface.LineReaderImpl.BellType LineReaderImpl.CompletionType LineReaderImpl.PostResult LineReaderImpl.State Possible states in which the current readline operation may be in.LineReaderImpl.ViMoveMode Macro A macro that executes a sequence of keystrokes when invoked.MaskingCallback Callback used to mask parts of the line for sensitive input like passwords.NullCompleter Null completer.ParsedLine ParsedLine
objects are returned by theParser
during completion or when accepting the line.Parser The Parser interface is responsible for parsing command lines into tokens.Parser.ParseContext PrintAboveWriter Redirects aWriter
to aLineReader
'sLineReader.printAbove(String)
method, which draws output above the current prompt / input line.ReaderUtils Utility methods for LineReader implementations.Reference A reference to aWidget
by name.SimpleMaskingCallback SimpleMaskingCallback
that will replace all the characters in the line with the given mask.StringsCompleter Completer for a set of strings.SyntaxError Exception thrown when a syntax error is encountered during parsing.SystemCompleter Completer which contains multiple completers and aggregates them together.UndoTree<T> Provides undo/redo functionality for the LineReader.UserInterruptException This exception is thrown byLineReader.readLine()
when user interrupt handling is enabled and the user types the interrupt character (ctrl-C).Widget A Widget represents an action that can be bound to a key sequence in the LineReader.