Uses of Class
org.jline.reader.Candidate
Packages that use Candidate
Package
Description
JLine Builtins provides a collection of utility classes and implementations for common terminal
functionality.
JLine Console package provides a framework for building interactive command-line applications.
JLine 3 Reader Package - Core components for building interactive command-line interfaces.
JLine 3 Reader Implementation Package.
JLine 3 Completer Implementations.
-
Uses of Candidate in org.jline.builtins
Method parameters in org.jline.builtins with type arguments of type CandidateModifier and TypeMethodDescriptionvoid
Completers.AnyCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) Completes the current word by returning it as a candidate.void
Completers.Completer.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Completes the current input line.void
Completers.FileNameCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) void
Completers.OptionCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) Completes command options and arguments.void
Completers.RegexCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Completes the current input line using the regex pattern.void
Completers.TreeCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Completes the current input line using the tree structure.protected void
Completers.Completer.completeCommand
(List<Candidate> candidates) Completes command names.protected void
Completers.Completer.completeCommandArguments
(LineReader reader, ParsedLine line, List<Candidate> candidates, List<Completers.CompletionData> completions) Completes command arguments based on completion data.protected void
Completers.OptDesc.completeOption
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates, boolean longOpt) Completes an option based on whether it's a short or long option.protected boolean
Completers.OptDesc.completeValue
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates, String curBuf, String partialValue) Completes the value for an option.protected void
Completers.Completer.tryCompleteArguments
(LineReader reader, ParsedLine line, List<Candidate> candidates) Attempts to complete command arguments. -
Uses of Candidate in org.jline.console
Methods in org.jline.console that return CandidateModifier and TypeMethodDescriptionstatic Candidate
CommandRegistry.createCandidate
(CommandRegistry[] commandRegistries, String command) Creates a completion candidate for the specified command. -
Uses of Candidate in org.jline.reader
Methods in org.jline.reader that return CandidateModifier and TypeMethodDescriptionCompletionMatcher.exactMatch()
Returns a candidate that exactly matches the current input, if any.Methods in org.jline.reader that return types with arguments of type CandidateModifier and TypeMethodDescriptionFilters the provided candidates based on the current matching criteria.Methods in org.jline.reader with parameters of type CandidateMethod parameters in org.jline.reader with type arguments of type CandidateModifier and TypeMethodDescriptionvoid
Completer.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Populates candidates with a list of possible completions for the command line.Filters the provided candidates based on the current matching criteria. -
Uses of Candidate in org.jline.reader.impl
Fields in org.jline.reader.impl with type parameters of type CandidateMethods in org.jline.reader.impl that return CandidateMethods in org.jline.reader.impl that return types with arguments of type CandidateModifier and TypeMethodDescriptionprotected Comparator
<Candidate> LineReaderImpl.getCandidateComparator
(boolean caseInsensitive, String word) CompletionMatcherImpl.simpleMatcher
(Predicate<String> predicate) CompletionMatcherImpl.simpleMatcher
(Predicate<String> predicate) CompletionMatcherImpl.typoMatcher
(String word, int errors, boolean caseInsensitive, String originalGroupName) CompletionMatcherImpl.typoMatcher
(String word, int errors, boolean caseInsensitive, String originalGroupName) Methods in org.jline.reader.impl with parameters of type CandidateModifier and TypeMethodDescriptionprotected LineReaderImpl.PostResult
LineReaderImpl.computePost
(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed) protected LineReaderImpl.PostResult
LineReaderImpl.computePost
(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed, Function<String, Integer> wcwidth, int width, boolean autoGroup, boolean groupName, boolean rowsFirst) protected void
LineReaderImpl.toColumns
(Object items, int width, int maxWidth, AttributedStringBuilder sb, Candidate selection, String completed, boolean rowsFirst, boolean doMenuList, int[] out) protected LineReaderImpl.PostResult
LineReaderImpl.toColumns
(List<Object> items, Candidate selection, String completed, Function<String, Integer> wcwidth, int width, boolean rowsFirst) Method parameters in org.jline.reader.impl with type arguments of type CandidateModifier and TypeMethodDescriptionprotected LineReaderImpl.PostResult
LineReaderImpl.computePost
(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed) protected LineReaderImpl.PostResult
LineReaderImpl.computePost
(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed, Function<String, Integer> wcwidth, int width, boolean autoGroup, boolean groupName, boolean rowsFirst) protected boolean
LineReaderImpl.doList
(List<Candidate> possible, String completed, boolean runLoop, BiFunction<CharSequence, Boolean, CharSequence> escaper) protected boolean
LineReaderImpl.doList
(List<Candidate> possible, String completed, boolean runLoop, BiFunction<CharSequence, Boolean, CharSequence> escaper, boolean forSuggestion) protected boolean
LineReaderImpl.doMenu
(List<Candidate> original, String completed, BiFunction<CharSequence, Boolean, CharSequence> escaper) -
Uses of Candidate in org.jline.reader.impl.completer
Fields in org.jline.reader.impl.completer with type parameters of type CandidateMethod parameters in org.jline.reader.impl.completer with type arguments of type CandidateModifier and TypeMethodDescriptionvoid
void
AggregateCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Perform a completion operation across all aggregated completers.void
ArgumentCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) void
FileNameCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) Deprecated.void
NullCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) void
StringsCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) void
SystemCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) Constructors in org.jline.reader.impl.completer with parameters of type CandidateConstructor parameters in org.jline.reader.impl.completer with type arguments of type Candidate