|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Completer
A completer provides completion suffixes for a given prefix. The cmdline framework uses it when computing a completion.
Method Summary | |
---|---|
ValueCompletion |
complete(ParameterDescriptor<?> parameter,
String prefix)
Query the completer for a set of completion for the given prefix. |
Method Detail |
---|
ValueCompletion complete(ParameterDescriptor<?> parameter, String prefix) throws Exception
Query the completer for a set of completion for the given prefix. The returned ValueCompletion
object
provides the possible suffixes matching the prefix argument. Each entry of the result maps to a possible
completion: an entry key is the possible completion, its corresponding boolean value indicates wether the value can
be further more completed or not.
The prefix value of the completion result is optional and gives a prefix to use more than one result is provided. The interest of the prefix is to limit the size of the completion to display when they can be long, for instance a pat completion returning several values could be display in columns, however only the last name of the path would be displayed and not the entire path.
The following guidelines should be respected:
Example: a completer that would complete colors could
Example: a completer that would complete java packages could
parameter
- the completed parameterprefix
- the prefix to complete
Exception
- any exception that would prevent completion to perform correctly
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |