org.nuxeo.shell

Class CommandRegistry

java.lang.Object

org.nuxeo.shell.CommandRegistry

Direct Known Subclasses:

ConfigurationCommands, EquinoxFeature, FileSystemCommands, GlobalCommands, RemoteCommands

public abstract class CommandRegistry
extends Object

A command registry associated to a given domain name. Registries are named so each registry is using a different namespace. For example you can have a "local" and a "remote" namespace using different command registries. Commands in local namespace are working on the filesystem while the one in remote namespace are working on a remote server.

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,CommandType>	cmds
protected String	name
protected CommandRegistry	parent

Constructor Summary

Constructors

Constructor and Description
CommandRegistry(CommandRegistry parent, String name)

Method Summary

Modifier and Type	Method and Description
void	addAnnotatedCommand(Class<? extends Runnable> clazz)
void	addCommandType(CommandType type)
void	autorun(Shell shell) Override this to automatically run some commands at startup if needed.
void	clear()
protected void	collectCommandTypesByNamespace(Map<String,Set<CommandType>> map)
String[]	getCommandNames() Get sorted command names including aliases
Set<String>	getCommandNameSet()
CommandType	getCommandType(String name)
CommandType[]	getCommandTypes()
Map<String,Set<CommandType>>	getCommandTypesByNamespace()
Set<CommandType>	getCommandTypeSet()
abstract String	getDescription()
CommandType[]	getLocalCommandTypes()
String	getName()
CommandRegistry	getParent()
String	getPrompt(Shell shell) Override this to provide a custom prompt for your command namespace
abstract String	getTitle()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

parent

protected CommandRegistry parent

cmds

protected Map<String,CommandType> cmds

Constructor Detail

CommandRegistry

public CommandRegistry(CommandRegistry parent,
                       String name)

Method Detail

getTitle

public abstract String getTitle()

getDescription

public abstract String getDescription()

getName

public String getName()

getParent

public CommandRegistry getParent()

addCommandType

public void addCommandType(CommandType type)

addAnnotatedCommand

public void addAnnotatedCommand(Class<? extends Runnable> clazz)

getCommandType

public CommandType getCommandType(String name)

getCommandTypeSet

public Set<CommandType> getCommandTypeSet()

getCommandTypes

public CommandType[] getCommandTypes()

getLocalCommandTypes

public CommandType[] getLocalCommandTypes()

collectCommandTypesByNamespace

protected void collectCommandTypesByNamespace(Map<String,Set<CommandType>> map)

getCommandTypesByNamespace

public Map<String,Set<CommandType>> getCommandTypesByNamespace()

getCommandNameSet

public Set<String> getCommandNameSet()

getCommandNames

public String[] getCommandNames()

Get sorted command names including aliases

Returns:

clear

public void clear()

getPrompt

public String getPrompt(Shell shell)

Override this to provide a custom prompt for your command namespace

Parameters:

shell -

Returns:

autorun

public void autorun(Shell shell)

Override this to automatically run some commands at startup if needed. This is invoked by the interactive mode just after it was started on the current namespace. This way you can do some initialization for your namespace if needed - like automatically connecting to remote if connection details were filled to the application command line arguments.