org.jboss.aesh.terminal

Interface Terminal

All Known Implementing Classes:

AbstractTerminal, POSIXTerminal, TestTerminal, WindowsTerminal

public interface Terminal

Generic interface for Terminals

Author:

Ståle W. Pedersen

Method Summary

Modifier and Type	Method and Description
void	clear() clears the screen
CursorPosition	getCursor()
TerminalSize	getSize()
void	init(InputStream inputStream, OutputStream stdOut, OutputStream stdErr) Initialize the Terminal with which input/output stream it should use
boolean	isEchoEnabled()
void	moveCursor(int rows, int columns) Move the cursor relative to the current position Will not move outside of TerminalSize boundaries
int[]	read(boolean readAhead) Read from the input stream (char by char)
void	reset() Set it back to normal when we exit
void	setCursor(CursorPosition position) Set cursor position
void	writeChar(TerminalCharacter c) Write a TerminalCharacter to std out
void	writeChars(List<TerminalCharacter> chars) Write a list of TerminalCharacters to std out
void	writeToStdErr(char err) Write to the standard error stream
void	writeToStdErr(char[] err) Write to the standard error stream
void	writeToStdErr(String err) Write to the standard error stream
void	writeToStdOut(char out) Write to the standard output stream
void	writeToStdOut(char[] out) Write to the standard output stream
void	writeToStdOut(String out) Write to the standard output stream

Method Detail

init

void init(InputStream inputStream,
          OutputStream stdOut,
          OutputStream stdErr)

Initialize the Terminal with which input/output stream it should use

Parameters:

inputStream - input

stdOut - standard output

stdErr - error output

read

int[] read(boolean readAhead)
    throws IOException

Read from the input stream (char by char)

Returns:

whats read

Throws:

IOException

writeToStdOut

void writeToStdOut(String out)
            throws IOException

Write to the standard output stream

Parameters:

out - what goes into the stream

Throws:

IOException - stream

writeToStdOut

void writeToStdOut(char[] out)
            throws IOException

Write to the standard output stream

Parameters:

out - what goes into the stream

Throws:

IOException - stream

writeToStdOut

void writeToStdOut(char out)
            throws IOException

Write to the standard output stream

Parameters:

out - what goes into the stream

Throws:

IOException - stream

writeToStdErr

void writeToStdErr(String err)
            throws IOException

Write to the standard error stream

Parameters:

err - what goes into the stream

Throws:

IOException - stream

writeToStdErr

void writeToStdErr(char[] err)
            throws IOException

Write to the standard error stream

Parameters:

err - what goes into the stream

Throws:

IOException - stream

writeToStdErr

void writeToStdErr(char err)
            throws IOException

Write to the standard error stream

Parameters:

err - what goes into the stream

Throws:

IOException - stream

getSize

TerminalSize getSize()

Returns:

terminal size

getCursor

CursorPosition getCursor()

Returns:

get the cursor position

setCursor

void setCursor(CursorPosition position)
        throws IOException

Set cursor position

Throws:

IOException

moveCursor

void moveCursor(int rows,
                int columns)
         throws IOException

Move the cursor relative to the current position Will not move outside of TerminalSize boundaries

Throws:

IOException

writeChar

void writeChar(TerminalCharacter c)
        throws IOException

Write a TerminalCharacter to std out

Throws:

IOException

writeChars

void writeChars(List<TerminalCharacter> chars)
         throws IOException

Write a list of TerminalCharacters to std out

Throws:

IOException

isEchoEnabled

boolean isEchoEnabled()

reset

void reset()
    throws IOException

Set it back to normal when we exit

Throws:

IOException - stream

clear

void clear()
    throws IOException

clears the screen

Throws:

IOException