info.informationsea.commandmanager.cli

Class CLICommandConsole

java.lang.Object

info.informationsea.commandmanager.cli.CLICommandConsole

public class CLICommandConsole
extends java.lang.Object

Command Manager for Command Line Interface. This command manager provides two built-in commands, "help" and "source". "help" command shows usage of commands. "source" command read a script file and run commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CLICommandConsole.CLIBuiltinCommand Super class of CLI command manager built-in commands
static class	CLICommandConsole.CLIHelpCommand
static class	CLICommandConsole.CLISourceCommand

Constructor Summary

Constructors

Constructor and Description
CLICommandConsole(CommandManager commandManager) Create CLICommandConsole to start console prompt.

Method Summary

Modifier and Type	Method and Description
void	execute(java.lang.String line) Execute a commands in the raw line.
void	execute(java.lang.String[] args) Execute a commands in the string array.
void	executeMany(java.lang.String line) Execute commands in the raw line.
void	executeMany(java.lang.String[] args) Execute commands in the parsed arguments.
CommandManager	getCommandManager()
ManagedCommand	getConfiguredCommandInstance(java.lang.String line) Get a configured commands in the raw line.
ManagedCommand	getConfiguredCommandInstance(java.lang.String[] args) Get a configured commands with a string array.
void	loadScript(java.io.Reader reader) Load a script from a reader and execute.
void	startConsole() Start console interface with the default console reader
void	startConsole(ConsoleReader consoleReader) Start console interface with consoleReader

Methods inherited from class java.lang.Object

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

Constructor Detail

CLICommandConsole

public CLICommandConsole(CommandManager commandManager)

Create CLICommandConsole to start console prompt.

Parameters:

commandManager - A command manager object.

Method Detail

executeMany

public void executeMany(java.lang.String line)
                 throws java.lang.Exception

Execute commands in the raw line. The raw line will be parsed with ShellParser.

Parameters:

line - commands. Commands should be separated by ';'

Throws:

java.lang.Exception - Commands may throw Exception.

executeMany

public void executeMany(java.lang.String[] args)
                 throws java.lang.Exception

Execute commands in the parsed arguments.

Parameters:

args - commands. Commands should be separated by ';'

Throws:

java.lang.Exception - Commands may throw Exception.

execute

public void execute(java.lang.String line)
             throws java.lang.Exception

Execute a commands in the raw line. The raw line will be parsed with ShellParser.

Parameters:

line - a command and its arguments.

Throws:

java.lang.Exception - A command may throw Exception.

execute

public void execute(java.lang.String[] args)
             throws java.lang.Exception

Execute a commands in the string array.

Parameters:

args - a command and its arguments.

Throws:

java.lang.Exception - A command may throw Exception.

getConfiguredCommandInstance

public ManagedCommand getConfiguredCommandInstance(java.lang.String line)
                                            throws java.lang.Exception

Get a configured commands in the raw line. Parameters of a command are configured with arguments. The raw line will be parsed with ShellParser.

Parameters:

line - a command and its arguments.

Returns:

A configured command instance

Throws:

java.lang.Exception - A argument parser may throw Exception.

getConfiguredCommandInstance

public ManagedCommand getConfiguredCommandInstance(java.lang.String[] args)
                                            throws java.lang.Exception

Get a configured commands with a string array. Parameters of a command are configured with arguments.

Parameters:

args - a command and its arguments.

Returns:

A configured command instance

Throws:

java.lang.Exception - A argument parser may throw Exception.

loadScript

public void loadScript(java.io.Reader reader)
                throws java.lang.Exception

Load a script from a reader and execute.

Parameters:

reader - script reader

Throws:

java.lang.Exception - commands may throw Exception

startConsole

public void startConsole()
                  throws java.io.IOException

Start console interface with the default console reader

Throws:

java.io.IOException - console reade may throw IOException

startConsole

public void startConsole(ConsoleReader consoleReader)
                  throws java.io.IOException

Start console interface with consoleReader

Parameters:

consoleReader - terminal console reader

Throws:

java.io.IOException - console reade may throw IOException

getCommandManager

public CommandManager getCommandManager()