CommandInvocation

All Known Implementing Classes:

AeshCommandInvocation
```
public interface CommandInvocation
```
A CommandInvocation is the value object passed to a Command when it is executed. It contain references to the current ControlOperator, registry, shell, ++

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`executeCommand(java.lang.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()`
`java.lang.String`	`getHelpInfo(java.lang.String commandName)`
`CommandOperation`	`getInput()` A blocking call that will return user input from the terminal
`java.lang.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(java.lang.String msg)` Print a message on console
`void`	`println(java.lang.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

- Method Detail
  - getControlOperator
```
ControlOperator getControlOperator()
```
    Returns:
    
    the control operator connected with this invocation
  - getCommandRegistry
```
CommandRegistry getCommandRegistry()
```
    Returns:
    
    the CommandRegistry
  - getShell
```
Shell getShell()
```
    Returns:
    
    the shell
  - setPrompt
```
void setPrompt(Prompt prompt)
```
    Specify the prompt
  - getPrompt
```
Prompt getPrompt()
```
    Returns:
    
    Get the current Prompt
  - getHelpInfo
```
java.lang.String getHelpInfo(java.lang.String commandName)
```
    Returns:
    
    a formatted usage/help info from the specified command
  - stop
```
void stop()
```
    Stop the console and end the session
  - getAeshContext
```
AeshContext getAeshContext()
```
    Get AeshContext
  - getInput
```
CommandOperation getInput()
                   throws java.lang.InterruptedException
```
    A blocking call that will return user input from the terminal
    
    Returns:
    
    user input
    
    Throws:
    
    java.lang.InterruptedException
  - getInputLine
```
java.lang.String getInputLine()
                       throws java.lang.InterruptedException
```
    A blocking call that will return user input from the terminal after the user has pressed enter.
    
    Returns:
    
    user input line
    
    Throws:
    
    java.lang.InterruptedException
  - getPid
```
int getPid()
```
    The process id.
    
    Returns:
    
    pid
  - putProcessInBackground
```
void putProcessInBackground()
```
    Put the current process in the background
  - putProcessInForeground
```
void putProcessInForeground()
```
    Put the current process in the foreground
  - executeCommand
```
void executeCommand(java.lang.String input)
```
    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.
    
    Parameters:
    
    input - command input
  - print
```
void print(java.lang.String msg)
```
    Print a message on console
    
    Parameters:
    
    msg -
  - println
```
void println(java.lang.String msg)
```
    Print a new line with a message on console;
    
    Parameters:
    
    msg -

Interface CommandInvocation

Method Summary

Method Detail

getControlOperator

getCommandRegistry

getShell

setPrompt

getPrompt

getHelpInfo

stop

getAeshContext

getInput

getInputLine

getPid

putProcessInBackground

putProcessInForeground

executeCommand

print

println