Package org.jline.reader
Class Candidate
- java.lang.Object
-
- org.jline.reader.Candidate
-
-
Constructor Summary
Constructors Constructor Description Candidate(java.lang.String value)
Simple constructor with only a single String as an argument.Candidate(java.lang.String value, java.lang.String displ, java.lang.String group, java.lang.String descr, java.lang.String suffix, java.lang.String key, boolean complete)
Constructs a new Candidate.Candidate(java.lang.String value, java.lang.String displ, java.lang.String group, java.lang.String descr, java.lang.String suffix, java.lang.String key, boolean complete, int sort)
Constructs a new Candidate.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.java.lang.String
descr()
Description of this candidate, usually a small help message to understand the meaning of this candidate.java.lang.String
displ()
The string that will be displayed to the user.boolean
equals(java.lang.Object o)
java.lang.String
group()
The group name for this candidate.int
hashCode()
java.lang.String
key()
Candidates which have the same key will be merged together.int
sort()
Integer used to override default sort logic.java.lang.String
suffix()
The suffix is added when this candidate is displayed.java.lang.String
toString()
java.lang.String
value()
The value that will be used for the actual completion.
-
-
-
Field Detail
-
value
private final java.lang.String value
-
displ
private final java.lang.String displ
-
group
private final java.lang.String group
-
descr
private final java.lang.String descr
-
suffix
private final java.lang.String suffix
-
key
private final java.lang.String key
-
complete
private final boolean complete
-
sort
private final int sort
-
-
Constructor Detail
-
Candidate
public Candidate(java.lang.String value)
Simple constructor with only a single String as an argument.- Parameters:
value
- the candidate
-
Candidate
public Candidate(java.lang.String value, java.lang.String displ, java.lang.String group, java.lang.String descr, java.lang.String suffix, java.lang.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(java.lang.String value, java.lang.String displ, java.lang.String group, java.lang.String descr, java.lang.String suffix, java.lang.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 java.lang.String value()
The value that will be used for the actual completion. This string should not contain ANSI sequences.- Returns:
- the value
-
displ
public java.lang.String displ()
The string that will be displayed to the user. This string may contain ANSI sequences.- Returns:
- the display string
-
group
public java.lang.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 java.lang.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 java.lang.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 java.lang.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:
compareTo
in interfacejava.lang.Comparable<Candidate>
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-