org.jboss.aesh.console

Class AeshConsoleImpl

java.lang.Object

org.jboss.aesh.console.AeshConsoleImpl

All Implemented Interfaces:

AeshConsole

public class AeshConsoleImpl
extends java.lang.Object
implements AeshConsole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	AeshConsoleImpl.AeshCompletion
(package private) class	AeshConsoleImpl.AeshConsoleCallbackImpl

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	commandInvocationProvider
private CommandInvocationServices	commandInvocationServices
private CommandNotFoundHandler	commandNotFoundHandler
private Console	console
private AeshInternalCommandRegistry	internalRegistry
private InvocationProviders	invocationProviders
private static java.util.logging.Logger	LOGGER
private ManProvider	manProvider
private CommandRegistry	registry

Constructor Summary

Constructors

Constructor and Description

AeshConsoleImpl(Settings settings, CommandRegistry registry, CommandInvocationServices commandInvocationServices, CommandNotFoundHandler commandNotFoundHandler, CompleterInvocationProvider completerInvocationProvider, ConverterInvocationProvider converterInvocationProvider, ValidatorInvocationProvider validatorInvocationProvider, OptionActivatorProvider optionActivatorProvider, ManProvider manProvider)

Method Summary

Modifier and Type	Method and Description
void	changeOutputStream(java.io.PrintStream output)
void	clear() Clear the terminal screen
private void	completeCommandName(CompleteOperation co)
void	execute(java.lang.String input)
AeshContext	getAeshContext() Get the AeshContext
java.lang.String	getBuffer()
private CommandContainer	getCommand(AeshLine aeshLine, java.lang.String line) try to return the command in the given registry if the given registry do not find the command, check if we have a internal registry and if its there.
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
InputProcessor	getInputProcessor()
ManProvider	getManProvider()
Prompt	getPrompt() Get the current Prompt
Shell	getShell()
boolean	isRunning() Is the console currently running?
private void	processAfterInit(Settings settings)
void	putProcessInBackground(int pid)
void	putProcessInForeground(int pid)
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.

Methods inherited from class java.lang.Object

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

Field Detail

console

private final Console console

registry

private final CommandRegistry registry

commandInvocationServices

private final CommandInvocationServices commandInvocationServices

invocationProviders

private final InvocationProviders invocationProviders

LOGGER

private static final java.util.logging.Logger LOGGER

manProvider

private final ManProvider manProvider

commandNotFoundHandler

private final CommandNotFoundHandler commandNotFoundHandler

internalRegistry

private AeshInternalCommandRegistry internalRegistry

commandInvocationProvider

private java.lang.String commandInvocationProvider

Constructor Detail

AeshConsoleImpl

AeshConsoleImpl(Settings settings,
                CommandRegistry registry,
                CommandInvocationServices commandInvocationServices,
                CommandNotFoundHandler commandNotFoundHandler,
                CompleterInvocationProvider completerInvocationProvider,
                ConverterInvocationProvider converterInvocationProvider,
                ValidatorInvocationProvider validatorInvocationProvider,
                OptionActivatorProvider optionActivatorProvider,
                ManProvider manProvider)

Method Detail

start

public void start()

Description copied from interface: AeshConsole

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

Specified by:

start in interface AeshConsole

stop

public void stop()

Description copied from interface: AeshConsole

Stop the Console, close streams and reset terminal settings.

Specified by:

stop in interface AeshConsole

getCommandRegistry

public CommandRegistry getCommandRegistry()

Description copied from interface: AeshConsole

Get the CommandRegistry

Specified by:

getCommandRegistry in interface AeshConsole

setPrompt

public void setPrompt(Prompt prompt)

Description copied from interface: AeshConsole

Specify the prompt

Specified by:

setPrompt in interface AeshConsole

getPrompt

public Prompt getPrompt()

Description copied from interface: AeshConsole

Get the current Prompt

Specified by:

getPrompt in interface AeshConsole

getShell

public Shell getShell()

Specified by:

getShell in interface AeshConsole

Returns:

get shell

clear

public void clear()

Description copied from interface: AeshConsole

Clear the terminal screen

Specified by:

clear in interface AeshConsole

getHelpInfo

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

Description copied from interface: AeshConsole

Get a formatted usage/help info from the specified command

Specified by:

getHelpInfo in interface AeshConsole

setCurrentCommandInvocationProvider

public void setCurrentCommandInvocationProvider(java.lang.String name)

Description copied from interface: AeshConsole

Specify the current CommandInvocationProvider

Specified by:

setCurrentCommandInvocationProvider in interface AeshConsole

registerCommandInvocationProvider

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

Description copied from interface: AeshConsole

Register a new CommandInvocationProvider

Specified by:

registerCommandInvocationProvider in interface AeshConsole

Parameters:

name - the name

commandInvocationProvider - the provider

getManProvider

public ManProvider getManProvider()

Specified by:

getManProvider in interface AeshConsole

getAeshContext

public AeshContext getAeshContext()

Description copied from interface: AeshConsole

Get the AeshContext

Specified by:

getAeshContext in interface AeshConsole

isRunning

public boolean isRunning()

Description copied from interface: AeshConsole

Is the console currently running?

Specified by:

isRunning in interface AeshConsole

getExportManager

public ExportManager getExportManager()

Specified by:

getExportManager in interface AeshConsole

getBuffer

public java.lang.String getBuffer()

getInputProcessor

public InputProcessor getInputProcessor()

putProcessInBackground

public void putProcessInBackground(int pid)

putProcessInForeground

public void putProcessInForeground(int pid)

execute

public void execute(java.lang.String input)

changeOutputStream

public void changeOutputStream(java.io.PrintStream output)

processAfterInit

private void processAfterInit(Settings settings)

completeCommandName

private void completeCommandName(CompleteOperation co)

getCommand

private CommandContainer getCommand(AeshLine aeshLine,
                                    java.lang.String line)
                             throws CommandNotFoundException

try to return the command in the given registry if the given registry do not find the command, check if we have a internal registry and if its there.

Parameters:

aeshLine - parsed command line

line - command line

Returns:

command

Throws:

CommandNotFoundException