org.jboss.aesh.console.command.invocation

Class AeshCommandInvocation

java.lang.Object

org.jboss.aesh.console.command.invocation.AeshCommandInvocation

All Implemented Interfaces:

CommandInvocation

public final class AeshCommandInvocation
extends Object
implements CommandInvocation

Author:

Ståle W. Pedersen

Constructor Summary

Constructors

Constructor and Description
AeshCommandInvocation(AeshConsoleImpl aeshConsole, ControlOperator controlOperator, int pid, ConsoleCallback callback)

Method Summary

Modifier and Type	Method and Description
void	executeCommand(String input) This will push the input to the input stream where aesh will parse it and execute it as a normal "user input".
AeshContext	getAeshContext() Get AeshContext
CommandRegistry	getCommandRegistry()
ControlOperator	getControlOperator()
String	getHelpInfo(String commandName)
CommandOperation	getInput() A blocking call that will return user input from the terminal
String	getInputLine() A blocking call that will return user input from the terminal after the user has pressed enter.
int	getPid() The process id.
Prompt	getPrompt()
Shell	getShell()
void	print(String msg) Print a message on console
void	println(String msg) Print a new line with a message on console;
void	putProcessInBackground() Put the current process in the background
void	putProcessInForeground() Put the current process in the foreground
void	setPrompt(Prompt prompt) Specify the prompt
void	stop() Stop the console and end the session

Methods inherited from class java.lang.Object

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

Constructor Detail

AeshCommandInvocation

public AeshCommandInvocation(AeshConsoleImpl aeshConsole,
                             ControlOperator controlOperator,
                             int pid,
                             ConsoleCallback callback)

Method Detail

getControlOperator

public ControlOperator getControlOperator()

Specified by:

getControlOperator in interface CommandInvocation

Returns:

the control operator connected with this invocation

getCommandRegistry

public CommandRegistry getCommandRegistry()

Specified by:

getCommandRegistry in interface CommandInvocation

Returns:

the CommandRegistry

getShell

public Shell getShell()

Specified by:

getShell in interface CommandInvocation

Returns:

the shell

setPrompt

public void setPrompt(Prompt prompt)

Description copied from interface: CommandInvocation

Specify the prompt

Specified by:

setPrompt in interface CommandInvocation

getPrompt

public Prompt getPrompt()

Specified by:

getPrompt in interface CommandInvocation

Returns:

Get the current Prompt

getHelpInfo

public String getHelpInfo(String commandName)

Specified by:

getHelpInfo in interface CommandInvocation

Returns:

a formatted usage/help info from the specified command

stop

public void stop()

Description copied from interface: CommandInvocation

Stop the console and end the session

Specified by:

stop in interface CommandInvocation

getAeshContext

public AeshContext getAeshContext()

Description copied from interface: CommandInvocation

Get AeshContext

Specified by:

getAeshContext in interface CommandInvocation

getInput

public CommandOperation getInput()
                          throws InterruptedException

Description copied from interface: CommandInvocation

A blocking call that will return user input from the terminal

Specified by:

getInput in interface CommandInvocation

Returns:

user input

Throws:

InterruptedException

getInputLine

public String getInputLine()
                    throws InterruptedException

Description copied from interface: CommandInvocation

A blocking call that will return user input from the terminal after the user has pressed enter.

Specified by:

getInputLine in interface CommandInvocation

Returns:

user input line

Throws:

InterruptedException

getPid

public int getPid()

Description copied from interface: CommandInvocation

The process id.

Specified by:

getPid in interface CommandInvocation

Returns:

pid

putProcessInBackground

public void putProcessInBackground()

Description copied from interface: CommandInvocation

Put the current process in the background

Specified by:

putProcessInBackground in interface CommandInvocation

putProcessInForeground

public void putProcessInForeground()

Description copied from interface: CommandInvocation

Put the current process in the foreground

Specified by:

putProcessInForeground in interface CommandInvocation

executeCommand

public void executeCommand(String input)

Description copied from interface: CommandInvocation

This will push the input to the input stream where aesh will parse it and execute it as a normal "user input". The input will not be visible for the user. Note that if this command still has the foreground this input will just be sitting on the queue.

Specified by:

executeCommand in interface CommandInvocation

Parameters:

input - command input

print

public void print(String msg)

Description copied from interface: CommandInvocation

Print a message on console

Specified by:

print in interface CommandInvocation

println

public void println(String msg)

Description copied from interface: CommandInvocation

Print a new line with a message on console;

Specified by:

println in interface CommandInvocation