org.crsh.cli.completers

Class EnumCompleter

java.lang.Object

org.crsh.cli.completers.EnumCompleter

All Implemented Interfaces:

Completer

public class EnumCompleter
extends Object
implements Completer

Constructor Summary

Constructors

Constructor and Description
EnumCompleter()

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.
static EnumCompleter	getInstance() Returns the empty completer instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnumCompleter

public EnumCompleter()

Method Detail

getInstance

public static EnumCompleter getInstance()

Returns the empty completer instance.

Returns:

the instance

complete

public Completion complete(ParameterDescriptor parameter,
                  String prefix)
                    throws Exception

Description copied from interface: Completer

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

Specified by:

complete in interface Completer

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