org.jboss.aesh.console

Class Console

java.lang.Object

org.jboss.aesh.console.Console

public class Console
extends Object

A console reader. Supports ansi terminals

Author:

Ståle W. Pedersen

Constructor Summary

Constructors

Constructor and Description
Console()
Console(Settings settings)

Method Summary

Modifier and Type	Method and Description
void	addCompletion(Completion completion) Add a Completion to the completion list
void	addCompletions(List<Completion> completionList) Add a list of completions to the completion list
protected void	attachProcess(ConsoleCommand cc) Used by ConsoleCommand to attach itself to the Console
void	clear() Clear a ansi terminal
void	clear(boolean includeBuffer) Clear an ansi terminal.
History	getHistory() Get the History object
Terminal	getTerminal()
TerminalSize	getTerminalSize()
boolean	isRunning()
void	moveCursor(int where)
void	pushToStdErr(char[] input)
void	pushToStdErr(String input)
void	pushToStdOut(char[] input)
void	pushToStdOut(String input) Push text to the console, note that this will not update the internal cursor position.
ConsoleOutput	read(Prompt prompt, Character mask) Read from the input stream, perform action according to mapped operations/completions/etc Return the stream when a new line is found.
ConsoleOutput	read(String prompt) Read from the input stream, perform action according to mapped operations/completions/etc Return the stream when a new line is found.
void	reset(Settings settings) Reset the Console with Settings Can only be called after stop()
void	stop() Stop the Console, close streams, and reset terminals.

Methods inherited from class java.lang.Object

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

Constructor Detail

Console

public Console()
        throws IOException

Throws:

IOException

Console

public Console(Settings settings)
        throws IOException

Throws:

IOException

Method Detail

reset

public void reset(Settings settings)
           throws IOException

Reset the Console with Settings Can only be called after stop()

Parameters:

settings - with given settings

Throws:

IOException - stream

getTerminalSize

public TerminalSize getTerminalSize()

Returns:

get the terminal size

getHistory

public History getHistory()

Get the History object

Returns:

history

pushToStdOut

public void pushToStdOut(String input)
                  throws IOException

Push text to the console, note that this will not update the internal cursor position.

Parameters:

input - text

Throws:

IOException - stream

pushToStdOut

public void pushToStdOut(char[] input)
                  throws IOException

Parameters:

input - chars

Throws:

IOException - stream

See Also:

pushToStdOut(java.lang.String)

pushToStdErr

public void pushToStdErr(String input)
                  throws IOException

Throws:

IOException

pushToStdErr

public void pushToStdErr(char[] input)
                  throws IOException

Throws:

IOException

addCompletion

public void addCompletion(Completion completion)

Add a Completion to the completion list

Parameters:

completion - comp

addCompletions

public void addCompletions(List<Completion> completionList)

Add a list of completions to the completion list

Parameters:

completionList - comps

stop

public void stop()
          throws IOException

Stop the Console, close streams, and reset terminals. WARNING: After this is called the Console object must be reset before its used.

Throws:

IOException - stream

isRunning

public boolean isRunning()

Returns:

true if Console is set up and streams are open

attachProcess

protected void attachProcess(ConsoleCommand cc)
                      throws IOException

Used by ConsoleCommand to attach itself to the Console

Parameters:

cc - command

Throws:

IOException - stream

getTerminal

public Terminal getTerminal()

Returns:

get the specified terminal

read

public ConsoleOutput read(String prompt)
                   throws IOException

Read from the input stream, perform action according to mapped operations/completions/etc Return the stream when a new line is found.

Parameters:

prompt - starting prompt

Returns:

input stream

Throws:

IOException - stream

read

public ConsoleOutput read(Prompt prompt,
                          Character mask)
                   throws IOException

Read from the input stream, perform action according to mapped operations/completions/etc Return the stream when a new line is found.

Parameters:

prompt - starting prompt

mask - if set typed chars will be masked with this specified char

Returns:

input stream

Throws:

IOException - stream

moveCursor

public final void moveCursor(int where)
                      throws IOException

Throws:

IOException

clear

public void clear()
           throws IOException

Clear a ansi terminal

Throws:

IOException - stream

clear

public void clear(boolean includeBuffer)
           throws IOException

Clear an ansi terminal. Set includeBuffer to true if the current buffer should be printed again after clear.

Parameters:

includeBuffer - if true include the current buffer line

Throws:

IOException - stream