org.crsh.cli.spi

Interface Completer

All Known Subinterfaces:

PathCompleter

All Known Implementing Classes:

AbstractPathCompleter, EmptyCompleter, EnumCompleter, FileCompleter, JCRCommand, JNDIHandler.JNDICompleter, SystemPropertyNameCompleter, ThreadCompleter

public interface Completer

Method Summary

Methods

Modifier and Type	Method and Description
Completion	complete(ParameterDescriptor parameter, String prefix) Query the completer for a set of completions for the given prefix.

Method Detail

complete

Completion complete(ParameterDescriptor parameter,
                  String prefix)
                    throws Exception

Query the completer for a set of completions for the given prefix. The returned Completion object provides the possible completion matching the prefix argument.

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