- 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 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.Candidate(String value, String displ, String group, String descr, String suffix, String key, boolean complete, int sort)Constructs a new Candidate.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompareTo(Candidate o)booleancomplete()Boolean indicating whether this candidate is complete or if the completer may further expand the candidate value after this candidate has been selected.Stringdescr()Description of this candidate, usually a small help message to understand the meaning of this candidate.Stringdispl()The string that will be displayed to the user.booleanequals(Object o)Stringgroup()The group name for this candidate.inthashCode()Stringkey()Candidates which have the same key will be merged together.intsort()Integer used to override default sort logic.Stringsuffix()The suffix is added when this candidate is displayed.StringtoString()Stringvalue()The value that will be used for the actual completion.
-
-
-
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, int sort)
Constructs a new Candidate.- Parameters:
value- the valuedispl- the display stringgroup- the groupdescr- the descriptionsuffix- the suffixkey- the keycomplete- the complete flagsort- the sort flag
-
Candidate
public Candidate(String value, String displ, String group, String descr, String suffix, String key, boolean complete)
Constructs a new Candidate.- Parameters:
value- the valuedispl- the display stringgroup- the groupdescr- the descriptionsuffix- the suffixkey- the keycomplete- 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
-
sort
public int sort()
Integer used to override default sort logic.- Returns:
- the sort int
-
compareTo
public int compareTo(Candidate o)
- Specified by:
compareToin interfaceComparable<Candidate>
-
-