org.crsh.jcr.command
Class JCRCommand

java.lang.Object
  extended by groovy.lang.GroovyObjectSupport
      extended by org.crsh.command.GroovyCommand
          extended by org.crsh.command.CRaSHCommand
              extended by org.crsh.jcr.command.JCRCommand
All Implemented Interfaces:
groovy.lang.GroovyObject, Completer, ShellCommand

public abstract class JCRCommand
extends CRaSHCommand
implements Completer

Version:
$Revision$
Author:
Julien Viet

Constructor Summary
protected JCRCommand()
           
 
Method Summary
 ValueCompletion complete(ParameterDescriptor<?> parameter, String prefix)
          Query the completer for a set of completion for the given prefix.
 
Methods inherited from class org.crsh.command.CRaSHCommand
complete, createInvoker, describe, getContext, getDescriptor, getUnmatched, getUnquoteArguments, readLine, readLine, setUnquoteArguments
 
Methods inherited from class org.crsh.command.GroovyCommand
getProperty, invokeMethod, setProperty
 
Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, setMetaClass
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JCRCommand

protected JCRCommand()
              throws IntrospectionException
Throws:
IntrospectionException
Method Detail

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.