org.crsh.cmdline.completers
Class EnumCompleter

java.lang.Object
  extended by org.crsh.cmdline.completers.EnumCompleter
All Implemented Interfaces:
Completer

public class EnumCompleter
extends Object
implements Completer

A completer for enums.

Version:
$Revision$
Author:
Julien Viet

Field Summary
private static EnumCompleter instance
          .
 
Constructor Summary
EnumCompleter()
           
 
Method Summary
 ValueCompletion complete(ParameterDescriptor<?> parameter, String prefix)
          Query the completer for a set of completion for the given prefix.
static EnumCompleter getInstance()
          Returns the empty completer instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

instance

private static final EnumCompleter instance
.

Constructor Detail

EnumCompleter

public EnumCompleter()
Method Detail

getInstance

public static EnumCompleter getInstance()
Returns the empty completer instance.

Returns:
the instance

complete

public ValueCompletion complete(ParameterDescriptor<?> parameter,
                                String prefix)
                         throws Exception
Description copied from interface: Completer

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

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


Copyright © 2012 eXo Platform SAS. All Rights Reserved.