Console

java.lang.Object
- org.jboss.aesh.console.Console

public class Console
extends java.lang.Object

A console reader. Supports ansi terminals

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class Console.ConsoleShell

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Console.ConsoleShell`

Field Summary

Fields
Modifier and Type	Field and Description
`private AliasManager`	`aliasManager`
`private CompletionHandler`	`completionHandler`
`private ConsoleBuffer`	`consoleBuffer`
`private ConsoleCallback`	`consoleCallback`
`private AeshContext`	`context`
`private boolean`	`controlledMode`
`private ConsoleOperation`	`currentOperation`
`private java.util.concurrent.ArrayBlockingQueue<int[]>`	`cursorQueue`
`private java.util.concurrent.ExecutorService`	`executorService`
`private ExportManager`	`exportManager`
`private boolean`	`initiateStop`
`private InputProcessor`	`inputProcessor`
`private java.util.concurrent.ArrayBlockingQueue<CommandOperation>`	`inputQueue`
`private static java.util.logging.Logger`	`LOGGER`
`private java.util.List<ConsoleOperation>`	`operations`
`private boolean`	`processing`
`private ProcessManager`	`processManager`
`private java.util.concurrent.ExecutorService`	`readerService`
`private boolean`	`reading`
`private boolean`	`readingCursor`
`private int[]`	`readingInput`
`private java.io.ByteArrayOutputStream`	`redirectPipeErrBuffer`
`private java.io.ByteArrayOutputStream`	`redirectPipeOutBuffer`
`private boolean`	`running`
`private Settings`	`settings`
`private Shell`	`shell`
`private AeshStandardStream`	`standardStream`

Constructor Summary

Constructors
Constructor and Description

Console(Settings settings)

Constructors
Constructor and Description
`Console(Settings settings)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletionRegistration`	`addCompletion(Completion completion)` Add a Completion to the completion list
`void`	`changeOutputStream(java.io.PrintStream output)`
`void`	`clear()` Clear a ansi terminal
`void`	`clearBufferAndDisplayPrompt()`
`void`	`continuous()`
`void`	`controlled()`
`void`	`currentProcessFinished(Process process)`
`private void`	`displayPrompt()`
`private void`	`doStop()` Stop the Console, close streams, and reset terminals.
`private java.io.PrintStream`	`err()`
`private void`	`execute()`
`private void`	`execute(java.lang.String command)`
`protected void`	`finalize()`
`private ConsoleOperation`	`findAliases(ConsoleOperation operation)`
`AeshContext`	`getAeshContext()`
`java.lang.String`	`getBuffer()` Get the current console buffer line (no masking)
`ConsoleCallback`	`getConsoleCallback()`
`ExportManager`	`getExportManager()`
`History`	`getHistory()` Get the History object
`protected CommandOperation`	`getInput()`
`java.lang.String`	`getInputLine()` Read from the input stream and return when user have pressed enter.
`protected InputProcessor`	`getInputProcessor()`
`private Shell`	`getInternalShell()`
`Prompt`	`getPrompt()`
`protected Settings`	`getSettings()`
`Shell`	`getShell()`
`private Terminal`	`getTerminal()`
`TerminalSize`	`getTerminalSize()`
`boolean`	`hasInput()`
`boolean`	`hasRunningProcesses()`
`private AeshStandardStream`	`in()`
`private void`	`init()` Reset the Console with Settings Can only be called after stop()
`boolean`	`isRunning()`
`boolean`	`isWaiting()` Returns true if the console is waiting for input and no foreground process is executing.
`boolean`	`isWaitingWithoutBackgroundProcess()` Returns true if the console is waiting for input and no process, foreground or background, is executing.
`private java.io.PrintStream`	`out()`
`private ConsoleOperation`	`parseCurrentOperation()`
`private void`	`parseInput(int[] input)`
`private ConsoleOperation`	`parseOperations()` Find the next ConsoleOutput based on operations
`private void`	`persistRedirection(java.lang.String fileName, ControlOperator redirection)`
`private ConsoleOperation`	`processInternalCommands(ConsoleOperation output)`
`private void`	`processInternalOperation(CommandOperation commandOperation)`
`private void`	`processOperationResult(java.lang.String result)`
`void`	`pushToInputStream(java.lang.String input)`
`void`	`putProcessInBackground(int pid)` Put the current process in the background
`void`	`putProcessInForeground(int pid)` Put the current process in the foreground
`private boolean`	`read()`
`private void`	`readExecuteFile()`
`void`	`setCompletionEnabled(boolean completionEnabled)` Runtime enable/disable of completion capabilities
`void`	`setConsoleCallback(ConsoleCallback consoleCallback)`
`void`	`setPrompt(Prompt prompt)` Set the current prompt.
`void`	`start()`
`private void`	`startExecutor()`
`private void`	`startReader()` Read from the input stream, perform action according to mapped operations/completions/etc
`void`	`stop()`
`void`	`updatePrompt(Prompt prompt)` Update the current prompt.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

settings
```
private Settings settings
```

consoleCallback

private ConsoleCallback consoleCallback

running
```
private volatile boolean running
```

initiateStop
```
private volatile boolean initiateStop
```

reading
```
private volatile boolean reading
```

readingInput
```
private volatile int[] readingInput
```

processing
```
private volatile boolean processing
```

redirectPipeOutBuffer

private java.io.ByteArrayOutputStream redirectPipeOutBuffer

redirectPipeErrBuffer

private java.io.ByteArrayOutputStream redirectPipeErrBuffer

operations

private java.util.List<ConsoleOperation> operations

currentOperation

private ConsoleOperation currentOperation

aliasManager
```
private AliasManager aliasManager
```

exportManager
```
private ExportManager exportManager
```

shell
```
private Shell shell
```

inputQueue

private java.util.concurrent.ArrayBlockingQueue<CommandOperation> inputQueue

cursorQueue

private java.util.concurrent.ArrayBlockingQueue<int[]> cursorQueue

readingCursor
```
private volatile boolean readingCursor
```

readerService

private java.util.concurrent.ExecutorService readerService

executorService

private java.util.concurrent.ExecutorService executorService

context
```
private AeshContext context
```

processManager
```
private ProcessManager processManager
```

consoleBuffer
```
private ConsoleBuffer consoleBuffer
```

inputProcessor
```
private InputProcessor inputProcessor
```

completionHandler

private CompletionHandler completionHandler

standardStream

private AeshStandardStream standardStream

controlledMode
```
private boolean controlledMode
```

LOGGER

private static final java.util.logging.Logger LOGGER

Constructor Detail
- Console
```
public Console(Settings settings)
```

Method Detail

finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getSettings
```
protected Settings getSettings()
```

init
```
private void init()
           throws java.io.IOException
```
Reset the Console with Settings Can only be called after stop()

Throws:

java.io.IOException - stream

getTerminalSize
```
public TerminalSize getTerminalSize()
```
Returns:

get the terminal size

getHistory
```
public History getHistory()
```
Get the History object

Returns:

history

setPrompt
```
public void setPrompt(Prompt prompt)
```
Set the current prompt.

Parameters:

prompt - prompt

updatePrompt
```
public void updatePrompt(Prompt prompt)
```
Update the current prompt. This will cause the prompt to be refreshed

Parameters:

prompt -

getPrompt
```
public Prompt getPrompt()
```

getExportManager

public ExportManager getExportManager()

setConsoleCallback

public void setConsoleCallback(ConsoleCallback consoleCallback)

getConsoleCallback

public ConsoleCallback getConsoleCallback()

changeOutputStream

public void changeOutputStream(java.io.PrintStream output)

isWaiting
```
public boolean isWaiting()
```
Returns true if the console is waiting for input and no foreground process is executing.

Returns:

isWaitingWithoutBackgroundProcess
```
public boolean isWaitingWithoutBackgroundProcess()
```
Returns true if the console is waiting for input and no process, foreground or background, is executing.

Returns:

controlled
```
public void controlled()
```

continuous
```
public void continuous()
```

start
```
public void start()
```

out
```
private java.io.PrintStream out()
```

err
```
private java.io.PrintStream err()
```

in
```
private AeshStandardStream in()
```

getAeshContext
```
public AeshContext getAeshContext()
```

addCompletion
```
public CompletionRegistration addCompletion(Completion completion)
```
Add a Completion to the completion list

Parameters:

completion - comp

setCompletionEnabled
```
public void setCompletionEnabled(boolean completionEnabled)
```
Runtime enable/disable of completion capabilities

Parameters:

completionEnabled -

stop
```
public void stop()
```

doStop
```
private void doStop()
             throws java.io.IOException
```
Stop the Console, close streams, and reset terminals. WARNING: After this is called the Console object must be reset before its used.

Throws:

java.io.IOException - stream

isRunning
```
public boolean isRunning()
```
Returns:

true if Console is set up and streams are open

clearBufferAndDisplayPrompt

public void clearBufferAndDisplayPrompt()

getInput

protected CommandOperation getInput()
                             throws java.lang.InterruptedException

Throws:: java.lang.InterruptedException

getInputProcessor

protected InputProcessor getInputProcessor()

putProcessInBackground
```
public void putProcessInBackground(int pid)
```
Put the current process in the background

putProcessInForeground
```
public void putProcessInForeground(int pid)
```
Put the current process in the foreground

pushToInputStream

public void pushToInputStream(java.lang.String input)

hasInput
```
public boolean hasInput()
```

hasRunningProcesses
```
public boolean hasRunningProcesses()
```

getInputLine
```
public java.lang.String getInputLine()
                              throws java.lang.InterruptedException
```
Read from the input stream and return when user have pressed enter. This method will block until enter is pressed or because of interruption.

Returns:

input

Throws:

java.lang.InterruptedException

getInternalShell
```
private Shell getInternalShell()
```
Returns:

get the current shell

getShell
```
public Shell getShell()
```
Returns:

get the current shell

currentProcessFinished

public void currentProcessFinished(Process process)

getTerminal
```
private Terminal getTerminal()
```

getBuffer
```
public java.lang.String getBuffer()
```
Get the current console buffer line (no masking)

Returns:

current buffer

startReader
```
private void startReader()
```
Read from the input stream, perform action according to mapped operations/completions/etc

startExecutor
```
private void startExecutor()
```

read
```
private boolean read()
```

parseInput

private void parseInput(int[] input)
                 throws java.lang.InterruptedException

Throws:: java.lang.InterruptedException

execute
```
private void execute()
```

execute

private void execute(java.lang.String command)
              throws java.lang.InterruptedException

Throws:: java.lang.InterruptedException

processInternalOperation

private void processInternalOperation(CommandOperation commandOperation)
                               throws java.io.IOException

Throws:: java.io.IOException

processOperationResult

private void processOperationResult(java.lang.String result)

displayPrompt
```
private void displayPrompt()
```

clear
```
public void clear()
           throws java.io.IOException
```
Clear a ansi terminal

Throws:

java.io.IOException - stream

parseCurrentOperation

private ConsoleOperation parseCurrentOperation()
                                        throws java.io.IOException

Throws:: java.io.IOException

parseOperations
```
private ConsoleOperation parseOperations()
                                  throws java.io.IOException
```
Find the next ConsoleOutput based on operations

Returns:

next ConsoleOutput

Throws:

java.io.IOException

processInternalCommands

private ConsoleOperation processInternalCommands(ConsoleOperation output)
                                          throws java.io.IOException

Throws:: java.io.IOException

findAliases

private ConsoleOperation findAliases(ConsoleOperation operation)

persistRedirection

private void persistRedirection(java.lang.String fileName,
                                ControlOperator redirection)
                         throws java.io.IOException

Throws:: java.io.IOException

readExecuteFile
```
private void readExecuteFile()
```

Class Console

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

settings

consoleCallback

running

initiateStop

reading

readingInput

processing

redirectPipeOutBuffer

redirectPipeErrBuffer

operations

currentOperation

aliasManager

exportManager

shell

inputQueue

cursorQueue

readingCursor

readerService

executorService

context

processManager

consoleBuffer

inputProcessor

completionHandler

standardStream

controlledMode

LOGGER

Constructor Detail

Console

Method Detail

finalize

getSettings

init

getTerminalSize

getHistory

setPrompt

updatePrompt

getPrompt

getExportManager

setConsoleCallback

getConsoleCallback

changeOutputStream

isWaiting

isWaitingWithoutBackgroundProcess

controlled

continuous

start

out

err

in

getAeshContext

addCompletion

setCompletionEnabled

stop

doStop

isRunning

clearBufferAndDisplayPrompt

getInput

getInputProcessor

putProcessInBackground

putProcessInForeground

pushToInputStream

hasInput

hasRunningProcesses

getInputLine

getInternalShell

getShell

currentProcessFinished

getTerminal

getBuffer

startReader

startExecutor

read