Uses of Class
org.jline.reader.Candidate

Packages that use Candidate

Package	Description
org.jline.builtins	JLine Builtins provides a collection of utility classes and implementations for common terminal functionality.
org.jline.console	JLine Console package provides a framework for building interactive command-line applications.
org.jline.console.impl
org.jline.reader	JLine 3 Reader Package - Core components for building interactive command-line interfaces.
org.jline.reader.impl	JLine 3 Reader Implementation Package.
org.jline.reader.impl.completer	JLine 3 Completer Implementations.

Uses of Candidate in org.jline.builtins

Method parameters in org.jline.builtins with type arguments of type Candidate

Modifier and Type	Method	Description
void	Completers.AnyCompleter.complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)	Completes the current word by returning it as a candidate.
void	Completers.Completer.complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)	Completes the current input line.
void	Completers.FileNameCompleter.complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)
void	Completers.OptionCompleter.complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)	Completes command options and arguments.
void	Completers.RegexCompleter.complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)	Completes the current input line using the regex pattern.
void	Completers.TreeCompleter.complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)	Completes the current input line using the tree structure.
protected void	Completers.Completer.completeCommand(java.util.List<Candidate> candidates)	Completes command names.
protected void	Completers.Completer.completeCommandArguments(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates, java.util.List<Completers.CompletionData> completions)	Completes command arguments based on completion data.
protected void	Completers.OptDesc.completeOption(LineReader reader, ParsedLine commandLine, java.util.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, java.util.List<Candidate> candidates, java.lang.String curBuf, java.lang.String partialValue)	Completes the value for an option.
protected void	Completers.Completer.tryCompleteArguments(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)	Attempts to complete command arguments.

Uses of Candidate in org.jline.console

Methods in org.jline.console that return Candidate

Modifier and Type	Method	Description
static Candidate	CommandRegistry.createCandidate(CommandRegistry[] commandRegistries, java.lang.String command)	Creates a completion candidate for the specified command.

Uses of Candidate in org.jline.console.impl

Method parameters in org.jline.console.impl with type arguments of type Candidate

Modifier and Type	Method	Description
void	ConsoleEngineImpl.VariableReferenceCompleter.complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)

Uses of Candidate in org.jline.reader

Methods in org.jline.reader that return Candidate

Modifier and Type	Method	Description
Candidate	CompletionMatcher.exactMatch()	Returns a candidate that exactly matches the current input, if any.

Methods in org.jline.reader that return types with arguments of type Candidate

Modifier and Type	Method	Description
java.util.List<Candidate>	CompletionMatcher.matches(java.util.List<Candidate> candidates)	Filters the provided candidates based on the current matching criteria.

Methods in org.jline.reader with parameters of type Candidate

Modifier and Type	Method	Description
int	Candidate.compareTo(Candidate o)

Method parameters in org.jline.reader with type arguments of type Candidate

Modifier and Type	Method	Description
void	Completer.complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)	Populates candidates with a list of possible completions for the command line.
java.util.List<Candidate>	CompletionMatcher.matches(java.util.List<Candidate> candidates)	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 Candidate

Modifier and Type	Field	Description
protected java.util.List<java.util.function.Function<java.util.Map<java.lang.String,java.util.List<Candidate>>,java.util.Map<java.lang.String,java.util.List<Candidate>>>>	CompletionMatcherImpl.matchers
protected java.util.List<java.util.function.Function<java.util.Map<java.lang.String,java.util.List<Candidate>>,java.util.Map<java.lang.String,java.util.List<Candidate>>>>	CompletionMatcherImpl.matchers

Methods in org.jline.reader.impl that return Candidate

Modifier and Type	Method	Description
Candidate	CompletionMatcherImpl.exactMatch()

Methods in org.jline.reader.impl that return types with arguments of type Candidate

Modifier and Type	Method	Description
protected java.util.Comparator<Candidate>	LineReaderImpl.getCandidateComparator(boolean caseInsensitive, java.lang.String word)
java.util.List<Candidate>	CompletionMatcherImpl.matches(java.util.List<Candidate> candidates)
protected java.util.function.Function<java.util.Map<java.lang.String,java.util.List<Candidate>>,java.util.Map<java.lang.String,java.util.List<Candidate>>>	CompletionMatcherImpl.simpleMatcher(java.util.function.Predicate<java.lang.String> predicate)
protected java.util.function.Function<java.util.Map<java.lang.String,java.util.List<Candidate>>,java.util.Map<java.lang.String,java.util.List<Candidate>>>	CompletionMatcherImpl.simpleMatcher(java.util.function.Predicate<java.lang.String> predicate)
protected java.util.function.Function<java.util.Map<java.lang.String,java.util.List<Candidate>>,java.util.Map<java.lang.String,java.util.List<Candidate>>>	CompletionMatcherImpl.typoMatcher(java.lang.String word, int errors, boolean caseInsensitive, java.lang.String originalGroupName)
protected java.util.function.Function<java.util.Map<java.lang.String,java.util.List<Candidate>>,java.util.Map<java.lang.String,java.util.List<Candidate>>>	CompletionMatcherImpl.typoMatcher(java.lang.String word, int errors, boolean caseInsensitive, java.lang.String originalGroupName)

Methods in org.jline.reader.impl with parameters of type Candidate

Modifier and Type	Method	Description
protected LineReaderImpl.PostResult	LineReaderImpl.computePost(java.util.List<Candidate> possible, Candidate selection, java.util.List<Candidate> ordered, java.lang.String completed)
protected LineReaderImpl.PostResult	LineReaderImpl.computePost(java.util.List<Candidate> possible, Candidate selection, java.util.List<Candidate> ordered, java.lang.String completed, java.util.function.Function<java.lang.String,java.lang.Integer> wcwidth, int width, boolean autoGroup, boolean groupName, boolean rowsFirst)
protected void	LineReaderImpl.toColumns(java.lang.Object items, int width, int maxWidth, AttributedStringBuilder sb, Candidate selection, java.lang.String completed, boolean rowsFirst, boolean doMenuList, int[] out)
protected LineReaderImpl.PostResult	LineReaderImpl.toColumns(java.util.List<java.lang.Object> items, Candidate selection, java.lang.String completed, java.util.function.Function<java.lang.String,java.lang.Integer> wcwidth, int width, boolean rowsFirst)

Method parameters in org.jline.reader.impl with type arguments of type Candidate

Modifier and Type	Method	Description
protected LineReaderImpl.PostResult	LineReaderImpl.computePost(java.util.List<Candidate> possible, Candidate selection, java.util.List<Candidate> ordered, java.lang.String completed)
protected LineReaderImpl.PostResult	LineReaderImpl.computePost(java.util.List<Candidate> possible, Candidate selection, java.util.List<Candidate> ordered, java.lang.String completed, java.util.function.Function<java.lang.String,java.lang.Integer> wcwidth, int width, boolean autoGroup, boolean groupName, boolean rowsFirst)
protected boolean	LineReaderImpl.doList(java.util.List<Candidate> possible, java.lang.String completed, boolean runLoop, java.util.function.BiFunction<java.lang.CharSequence,java.lang.Boolean,java.lang.CharSequence> escaper)
protected boolean	LineReaderImpl.doList(java.util.List<Candidate> possible, java.lang.String completed, boolean runLoop, java.util.function.BiFunction<java.lang.CharSequence,java.lang.Boolean,java.lang.CharSequence> escaper, boolean forSuggestion)
protected boolean	LineReaderImpl.doMenu(java.util.List<Candidate> original, java.lang.String completed, java.util.function.BiFunction<java.lang.CharSequence,java.lang.Boolean,java.lang.CharSequence> escaper)
java.util.List<Candidate>	CompletionMatcherImpl.matches(java.util.List<Candidate> candidates)

Uses of Candidate in org.jline.reader.impl.completer

Fields in org.jline.reader.impl.completer with type parameters of type Candidate

Modifier and Type	Field	Description
protected java.util.Collection<Candidate>	StringsCompleter.candidates

Method parameters in org.jline.reader.impl.completer with type arguments of type Candidate

Modifier and Type	Method	Description
void	SystemCompleter.compile(java.util.function.Function<java.lang.String,Candidate> candidateBuilder)
void	AggregateCompleter.complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)	Perform a completion operation across all aggregated completers.
void	ArgumentCompleter.complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)
void	FileNameCompleter.complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)	Deprecated.
void	NullCompleter.complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)
void	StringsCompleter.complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)
void	SystemCompleter.complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)

Constructors in org.jline.reader.impl.completer with parameters of type Candidate

Constructor	Description
StringsCompleter(Candidate... candidates)

Constructor parameters in org.jline.reader.impl.completer with type arguments of type Candidate

Constructor	Description
StringsCompleter(java.util.Collection<Candidate> candidates)