net.rubygrapefruit.platform.terminal

Interface TerminalInput

All Known Implementing Classes:

PosixTerminalInput, WindowsTerminalInput

public interface TerminalInput

Allows input to be received from the terminal.

On UNIX based platforms, this provides access to the terminal. On Windows platforms, this provides access to the console.

To create an instance of this interface use the Terminals.getTerminalInput() method.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getInputStream() Returns an input stream that can be used to read characters from this terminal.
TerminalInput	rawMode() Switches this terminal to raw mode.
void	read(TerminalInputListener listener) Reads characters and control keys from this terminal.
TerminalInput	reset() Resets this terminal to its default mode.

Method Detail

getInputStream

java.io.InputStream getInputStream()

Returns an input stream that can be used to read characters from this terminal.

read

void read(TerminalInputListener listener)
   throws NativeException

Reads characters and control keys from this terminal.

Throws:

NativeException

rawMode

TerminalInput rawMode()
               throws NativeException

Switches this terminal to raw mode. Keys are delivered as they are typed, are not echoed and are not processed.

Throws:

NativeException

reset

TerminalInput reset()
             throws NativeException

Resets this terminal to its default mode.

Throws:

NativeException