org.jboss.aesh.console

Interface AeshConsole

All Known Implementing Classes:

AeshConsoleImpl

public interface AeshConsole

A Console that manages Commands and properly execute them.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the terminal screen
AeshContext	getAeshContext() Get the AeshContext
CommandRegistry	getCommandRegistry() Get the CommandRegistry
ExportManager	getExportManager()
java.lang.String	getHelpInfo(java.lang.String commandName) Get a formatted usage/help info from the specified command
ManProvider	getManProvider()
Prompt	getPrompt() Get the current Prompt
Shell	getShell()
boolean	isRunning() Is the console currently running?
void	registerCommandInvocationProvider(java.lang.String name, CommandInvocationProvider commandInvocationProvider) Register a new CommandInvocationProvider
void	setCurrentCommandInvocationProvider(java.lang.String name) Specify the current CommandInvocationProvider
void	setPrompt(Prompt prompt) Specify the prompt
void	start() Start the Console.
void	stop() Stop the Console, close streams and reset terminal settings.

Method Detail

start

void start()

Start the Console. Open stream and set the proper terminal settings.

stop

void stop()

Stop the Console, close streams and reset terminal settings.

getCommandRegistry

CommandRegistry getCommandRegistry()

Get the CommandRegistry

setPrompt

void setPrompt(Prompt prompt)

Specify the prompt

getPrompt

Prompt getPrompt()

Get the current Prompt

getShell

Shell getShell()

Returns:

get shell

clear

void clear()

Clear the terminal screen

getHelpInfo

java.lang.String getHelpInfo(java.lang.String commandName)

Get a formatted usage/help info from the specified command

setCurrentCommandInvocationProvider

void setCurrentCommandInvocationProvider(java.lang.String name)

Specify the current CommandInvocationProvider

registerCommandInvocationProvider

void registerCommandInvocationProvider(java.lang.String name,
                                       CommandInvocationProvider commandInvocationProvider)

Register a new CommandInvocationProvider

Parameters:

name - the name

commandInvocationProvider - the provider

getManProvider

ManProvider getManProvider()

getAeshContext

AeshContext getAeshContext()

Get the AeshContext

isRunning

boolean isRunning()

Is the console currently running?

getExportManager

ExportManager getExportManager()