JCRCommand (CRaSH reference documentation 1.2.10 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.crsh.jcr.command
Class JCRCommand

java.lang.Object
  groovy.lang.GroovyObjectSupport
      org.crsh.command.GroovyCommand
          org.crsh.command.CRaSHCommand
              org.crsh.jcr.command.JCRCommand

All Implemented Interfaces:: groovy.lang.GroovyObject, Completer, ShellCommand, PathCompleter

public abstract class JCRCommand

extends CRaSHCommand

implements PathCompleter

Field Summary

Fields inherited from class org.crsh.command.CRaSHCommand
`unmatched`

Fields inherited from class org.crsh.command.GroovyCommand
`context, out`

Constructor Summary
`protected`	`JCRCommand()`

Method Summary
`Completion`	`complete(ParameterDescriptor parameter, String prefix)` Query the completer for a set of completions for the given prefix.

Methods inherited from class org.crsh.command.CRaSHCommand
`complete, describe, execute, getDescriptor, getUnmatched, readLine, readLine, resolveInvoker, resolveInvoker, resolveInvoker`

Methods inherited from class org.crsh.command.GroovyCommand
`getProperty, invokeMethod, peekContext, popContext, pushContext, 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 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