org.adroitlogic.x.terminal.core

Class CommandRegistry

java.lang.Object

org.adroitlogic.x.terminal.core.CommandRegistry

public class CommandRegistry
extends Object

Keeps track of all the registered commands in the terminal and the relevant executors.

Since:

17.01

Author:

sampath, Janaka Bandara

Constructor Summary

Constructors

Constructor and Description
CommandRegistry() Given an object instance this method looks for public methods in that given object with the annotation @TerminalCommand and tries to register those as terminal commands with creating a command executor for that method.

Method Summary

Modifier and Type	Method and Description
(package private) CommandExecutor	getCommandExecutor(String key) Retrieves the executor for the given command name or the alias
Collection<CommandExecutor>	getRegisteredCommandExecutors() Retrieves all the registered command executors
(package private) boolean	isRegistered(String key) Checks whether there is a command executor registered for the give command

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandRegistry

CommandRegistry()

Given an object instance this method looks for public methods in that given object with the annotation @TerminalCommand and tries to register those as terminal commands with creating a command executor for that method.

Further if a method annotated with the above annotation has parameters annotated with @CommandOption those will be considered as options of the terminal command.

Method Detail

isRegistered

boolean isRegistered(String key)

Checks whether there is a command executor registered for the give command

Parameters:

key - command name or the alias to check for an executor

Returns:

true if there is an executor registered, false otherwise

getCommandExecutor

CommandExecutor getCommandExecutor(String key)

Retrieves the executor for the given command name or the alias

Parameters:

key - name or the alias of the command

Returns:

the executor for the given command name or alias

getRegisteredCommandExecutors

public Collection<CommandExecutor> getRegisteredCommandExecutors()

Retrieves all the registered command executors

Returns:

all the registered command executors