org.jboss.aesh.console

Interface ConsoleCallback

All Known Implementing Classes:

AeshConsoleCallback, AeshConsoleImpl.AeshConsoleCallbackImpl

public interface ConsoleCallback

Implementation of this interface will be called when a user press the "enter/return" key. The return value is to indicate if the outcome was a success or not. Return 0 for success and something else for failure (typical 1 or -1).

Method Summary

Modifier and Type	Method and Description
int	execute(ConsoleOperation output) Will be executed when a return is pressed
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.
void	setProcess(Process process) Internally callback method

Method Detail

execute

int execute(ConsoleOperation output)
     throws java.lang.InterruptedException

Will be executed when a return is pressed

Parameters:

output - the consoleOperation

Returns:

0 for success or 1/-1 for failure.

Throws:

java.lang.InterruptedException

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

setProcess

void setProcess(Process process)

Internally callback method

Parameters:

process - current process