org.crsh.cmdline.spi
Interface Completer

All Known Implementing Classes:

EmptyCompleter, EnumCompleter, JCRCommand

public interface Completer

A completer provides completion suffixes for a given prefix. The cmdline framework uses it when computing a completion.

Version:

$Revision$

Author:

Julien Viet

Method Summary

Map<String,Boolean>

complete(ParameterDescriptor<?> parameter, String prefix) Query the completer for a set of completion for the given prefix.

Method Detail

complete

Map<String,Boolean> complete(ParameterDescriptor<?> parameter,
                             String prefix)
                             throws Exception

Query the completer for a set of completion for the given prefix. The returned Map should provide the possible suffixes matching the prefix argument. Each map entry 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 following guidelines should be respected:

• An empty map means no completion can be determined, the framework will not do anything.
• A singleton map means the match was entire and the framework will complete it with the sole map entry.
• A map containing string sharing a common prefix instruct the framework to insert this common prefix.
• A list containing strings with no common prefix (other than the empty string) instruct the framework to display the list of possible completions.

When a match is considered as full (the entry value is set to true), the completion should contain a trailing value that is usually a white space (but it could be a quote for quoted values).

Example: a completer that would complete colors could

• return the map ["lack ":true,"lue ":true] for the prefix "b".
• return the amp ["e ":true] for the prefix "blu".
• return the map [] for the prefix "z".

Example: a completer that would complete java packages could

• return the map ["ext":true,"ext.spi":false] for the prefix "java.t"

Parameters:

parameter - the completed parameter

prefix - the prefix to complete

Returns:

the possible suffix map

Throws:

Exception - any exception that would prevent completion to perform correctly