OpenJDK 27 · jdk.internal.org.jline.reader.Candidate

Modifier and Type	Field and Description
private final boolean	complete
private final String	descr
private final String	displ
private final String	group
private final String	key
private final int	sort
private final String	suffix
private final String	value

Access	Constructor and Description
public	Candidate(String the candidate value) Simple constructor with only a single String as an argument.
public	Candidate(String the value value, String the display string displ, String the group group, String the description descr, String the suffix suffix, String the key key, boolean the complete flag complete, int the sort flag sort) Constructs a new Candidate.
public	Candidate(String the value value, String the display string displ, String the group group, String the description descr, String the suffix suffix, String the key key, boolean the complete flag complete) Constructs a new Candidate.

Method Summary

Modifier and Type	Method and Description
public int	compareTo(Candidate o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	Returns: the completion flag complete() Boolean indicating whether this candidate is complete or if the completer may further expand the candidate value after this candidate has been selected.
public String	Returns: the description descr() Description of this candidate, usually a small help message to understand the meaning of this candidate.
public String	Returns: the display string displ() The string that will be displayed to the user.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the group group() The group name for this candidate.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	Returns: the key key() Candidates which have the same key will be merged together.
public int	Returns: the sort int sort() Integer used to override default sort logic.
public String	Returns: the suffix suffix() The suffix is added when this candidate is displayed.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	Returns: the value value() The value that will be used for the actual completion.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

complete	back to summary
private final boolean complete

descr	back to summary
private final String descr

displ	back to summary
private final String displ

group	back to summary
private final String group

key	back to summary
private final String key

sort	back to summary
private final int sort

suffix	back to summary
private final String suffix

value	back to summary
private final String value

Candidate	back to summary
public Candidate(String value) Simple constructor with only a single String as an argument. Parameters value:String the candidate

Candidate	back to summary
public Candidate(String value, String displ, String group, String descr, String suffix, String key, boolean complete, int sort) Constructs a new Candidate. Parameters value:String the value displ:String the display string group:String the group descr:String the description suffix:String the suffix key:String the key complete:boolean the complete flag sort:int the sort flag

Candidate	back to summary
public Candidate(String value, String displ, String group, String descr, String suffix, String key, boolean complete) Constructs a new Candidate. Parameters value:String the value displ:String the display string group:String the group descr:String the description suffix:String the suffix key:String the key complete:boolean the complete flag

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(Candidate o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(Candidate o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

complete	back to summary
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:boolean the completion flag

complete

back to summary

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:boolean: the completion flag

descr	back to summary
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:String the description

descr

back to summary

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:String: the description

displ	back to summary
public String displ() The string that will be displayed to the user. This string may contain ANSI sequences. Returns:String the display string

displ

back to summary

public String displ()

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

Returns:String: the display string

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

group back to summary

group	back to summary
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:String the group See Also `LineReader.Option#GROUP`, `LineReader.Option#AUTO_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:String: the group
See Also: LineReader.Option#GROUP, LineReader.Option#AUTO_GROUP

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

key	back to summary
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:String the key

key

back to summary

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:String: the key

sort	back to summary
public int sort() Integer used to override default sort logic. Returns:int the sort int

sort

back to summary

public int sort()

Integer used to override default sort logic.

Returns:int: the sort int

suffix back to summary

suffix	back to summary
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:String the suffix See Also `LineReader.Option#AUTO_REMOVE_SLASH`, `LineReader#REMOVE_SUFFIX_CHARS`

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:String: the suffix
See Also: LineReader.Option#AUTO_REMOVE_SLASH, LineReader#REMOVE_SUFFIX_CHARS

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

value	back to summary
public String value() The value that will be used for the actual completion. This string should not contain ANSI sequences. Returns:String the value

value

back to summary

public String value()

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

Returns:String: the value

public Class Candidate

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail