org.nuxeo.shell.impl

Class AbstractCommandType

java.lang.Object

org.nuxeo.shell.impl.AbstractCommandType

All Implemented Interfaces:

Comparable<CommandType>, CommandType

Direct Known Subclasses:

DefaultCommandType, OperationCommandType

public abstract class AbstractCommandType
extends Object
implements CommandType

Author:

Bogdan Stefanescu

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.shell.CommandType

CommandType.Setter, CommandType.Token

Field Summary

Fields

Modifier and Type	Field and Description
protected List<CommandType.Token>	args
protected Class<? extends Runnable>	cmdClass
protected List<CommandType.Setter>	injectable
protected Map<String,CommandType.Token>	params

Constructor Summary

Constructors

Constructor and Description
AbstractCommandType(Class<? extends Runnable> cmdClass, List<CommandType.Setter> injectable, Map<String,CommandType.Token> params, List<CommandType.Token> args)

Method Summary

Modifier and Type	Method and Description
int	compareTo(CommandType o)
protected Runnable	createInstance(Shell shell)
List<CommandType.Token>	getArguments()
Class<?>	getCommandClass()
protected CommandType.Token	getLastToken(String... line) The last element in line must be an empty element (e.g.
jline.Completor	getLastTokenCompletor(Shell shell, String... line)
protected jline.Completor	getParamCompletor(String prefix)
Map<String,CommandType.Token>	getParameters()
String	getSyntax()
protected void	inject(Shell shell, Runnable cmd, String... line)
Runnable	newInstance(Shell shell, String... line)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.shell.CommandType

getAliases, getHelp, getName

Field Detail

cmdClass

protected Class<? extends Runnable> cmdClass

injectable

protected List<CommandType.Setter> injectable

params

protected Map<String,CommandType.Token> params

args

protected List<CommandType.Token> args

Constructor Detail

AbstractCommandType

public AbstractCommandType(Class<? extends Runnable> cmdClass,
                           List<CommandType.Setter> injectable,
                           Map<String,CommandType.Token> params,
                           List<CommandType.Token> args)

Method Detail

getCommandClass

public Class<?> getCommandClass()

Specified by:

getCommandClass in interface CommandType

getArguments

public List<CommandType.Token> getArguments()

Specified by:

getArguments in interface CommandType

getParameters

public Map<String,CommandType.Token> getParameters()

Specified by:

getParameters in interface CommandType

getSyntax

public String getSyntax()

Specified by:

getSyntax in interface CommandType

newInstance

public Runnable newInstance(Shell shell,
                            String... line)
                     throws ShellException

Specified by:

newInstance in interface CommandType

Throws:

ShellException

createInstance

protected Runnable createInstance(Shell shell)
                           throws Exception

Throws:

Exception

getLastToken

protected CommandType.Token getLastToken(String... line)

The last element in line must be an empty element (e.g. "") if you need the next argument that may match. If the last element is not empty then this element will be returned as an argument or parameter.

Parameters:

line -

Returns:

getParamCompletor

protected jline.Completor getParamCompletor(String prefix)

getLastTokenCompletor

public jline.Completor getLastTokenCompletor(Shell shell,
                                             String... line)

Specified by:

getLastTokenCompletor in interface CommandType

inject

protected void inject(Shell shell,
                      Runnable cmd,
                      String... line)
               throws ShellException

Throws:

ShellException

compareTo

public int compareTo(CommandType o)

Specified by:

compareTo in interface Comparable<CommandType>