org.jline.reader

Class Candidate

java.lang.Object

org.jline.reader.Candidate

All Implemented Interfaces:

Comparable<Candidate>

public class Candidate
extends Object
implements Comparable<Candidate>

A completion candidate.

Author:

Guillaume Nodet

Constructor Summary

Constructors

Constructor and Description
Candidate(String value) Simple constructor with only a single String as an argument.
Candidate(String value, String displ, String group, String descr, String suffix, String key, boolean complete) Constructs a new Candidate.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Candidate o)
boolean	complete() Boolean indicating whether this candidate is complete or if the completer may further expand the candidate value after this candidate has been selected.
String	descr() Description of this candidate, usually a small help message to understand the meaning of this candidate.
String	displ() The string that will be displayed to the user.
String	group() The group name for this candidate.
String	key() Candidates which have the same key will be merged together.
String	suffix() The suffix is added when this candidate is displayed.
String	toString()
String	value() The value that will be used for the actual completion.

Methods inherited from class java.lang.Object

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

Constructor Detail

Candidate

public Candidate(String value)

Simple constructor with only a single String as an argument.

Parameters:

value - the candidate

Candidate

public Candidate(String value,
                 String displ,
                 String group,
                 String descr,
                 String suffix,
                 String key,
                 boolean complete)

Constructs a new Candidate.

Parameters:

value - the value

displ - the display string

group - the group

descr - the description

suffix - the suffix

key - the key

complete - the complete flag

Method Detail

value

public String value()

The value that will be used for the actual completion. This string should not contain ANSI sequences.

Returns:

the value

displ

public String displ()

The string that will be displayed to the user. This string may contain ANSI sequences.

Returns:

the display string

group

public String group()

The group name for this candidate. Candidates can be grouped together and this string is used as a key for the group and displayed to the user.

Returns:

the group

See Also:

LineReader.Option.GROUP, LineReader.Option.AUTO_GROUP

descr

public String descr()

Description of this candidate, usually a small help message to understand the meaning of this candidate. This string may contain ANSI sequences.

Returns:

the description

suffix

public String suffix()

The suffix is added when this candidate is displayed. However, if the next character entered does not match, the suffix will be automatically removed. This string should not contain ANSI sequences.

Returns:

the suffix

See Also:

LineReader.Option.AUTO_REMOVE_SLASH, LineReader.REMOVE_SUFFIX_CHARS

key

public String key()

Candidates which have the same key will be merged together. For example, if a command has multiple aliases, they can be merged if they are using the same key.

Returns:

the key

complete

public boolean complete()

Boolean indicating whether this candidate is complete or if the completer may further expand the candidate value after this candidate has been selected. This can be the case when completing folders for example. If the candidate is complete and is selected, a space separator will be added.

Returns:

the completion flag

compareTo

public int compareTo(Candidate o)

Specified by:

compareTo in interface Comparable<Candidate>

toString

public String toString()

Overrides:

toString in class Object