net.morimekta.console.terminal

Class Terminal

java.lang.Object

net.morimekta.console.chr.CharReader

net.morimekta.console.terminal.Terminal

All Implemented Interfaces:

Closeable, AutoCloseable, LinePrinter

public class Terminal
extends CharReader
implements Closeable, LinePrinter

Terminal interface. It sets proper TTY mode and reads complex characters from the input, and writes lines dependent on terminal mode.

Constructor Summary

Constructors

Constructor and Description
Terminal() Construct a default RAW terminal.
Terminal(STTY tty) Construct a default RAW terminal.
Terminal(STTY tty, InputStream in, OutputStream out, LinePrinter lp, STTYModeSwitcher switcher) Constructor visible for testing.
Terminal(STTY tty, LinePrinter lp) Construct a terminal with a custom line printer.
Terminal(STTY tty, STTYMode mode) Construct a terminal with given mode.
Terminal(STTY tty, STTYMode mode, LinePrinter lp) Construct a terminal with a terminal mode and custom line printer.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	confirm(String what) Make a user confirmation.
boolean	confirm(String what, boolean def) Make a user confirmation.
<T> T	executeAbortable(ExecutorService exec, Callable<T> callable) Execute callable, which may not be interruptable by itself, but listen to terminal input and abort the task if CTRL-C is pressed.
void	executeAbortable(ExecutorService exec, Runnable callable) Execute runnable, which may not be interruptable by itself, but listen to terminal input and abort the task if CTRL-C is pressed.
void	finish() Finish the current set of lines and continue below.
void	format(String format, Object... args)
protected OutputStream	getOutputStream()
STTY	getTTY()
void	print(Char ch)
void	print(String message)
PrintStream	printer() Get a print stream that writes to the terminal according to the output mode of the terminal.
void	println()
void	println(String message) Print a new line to the terminal.
protected void	sleep(long millis)
<T> void	waitAbortable(Future<T> task) Wait for future task to be done or canceled.

Methods inherited from class net.morimekta.console.chr.CharReader

read, readIfAvailable

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.morimekta.console.terminal.LinePrinter

error, fatal, formatln, info, warn

Constructor Detail

Terminal

public Terminal()

Construct a default RAW terminal.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

public Terminal(STTY tty)

Construct a default RAW terminal.

Parameters:

tty - The terminal device.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

public Terminal(STTY tty,
                STTYMode mode)

Construct a terminal with given mode.

Parameters:

tty - The terminal device.

mode - The terminal mode.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

public Terminal(STTY tty,
                LinePrinter lp)

Construct a terminal with a custom line printer.

Parameters:

tty - The terminal device.

lp - The line printer.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

public Terminal(STTY tty,
                STTYMode mode,
                LinePrinter lp)

Construct a terminal with a terminal mode and custom line printer.

Parameters:

tty - The terminal device.

mode - The terminal mode.

lp - The line printer.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

public Terminal(STTY tty,
                InputStream in,
                OutputStream out,
                LinePrinter lp,
                STTYModeSwitcher switcher)

Constructor visible for testing.

Parameters:

tty - The terminal device.

in - The input stream.

out - The output stream.

lp - The line printer or null.

switcher - TTY mode switcher.

Throws:

UncheckedIOException - If unable to set TTY mode.

Method Detail

getTTY

public STTY getTTY()

Returns:

Get the terminal device.

printer

public PrintStream printer()

Get a print stream that writes to the terminal according to the output mode of the terminal. Handy for e.g. printing stack traces etc while in raw mode.

Returns:

A wrapping print stream.

confirm

public boolean confirm(String what)

Make a user confirmation. E.g.: boolean really = term.confirm("Do you o'Really?"); Will print out "Do you o'Really? [Y/n]: ". If the user press 'y' and 'enter' will pass (return true), if 'n', and 'backspace' will return false. Invalid characters will print a short error message.

Parameters:

what - What to confirm. Basically the message before '[Y/n]'.

Returns:

Confirmation result.

confirm

public boolean confirm(String what,
                       boolean def)

Make a user confirmation. E.g.: boolean really = term.confirm("Do you o'Really?", false); Will print out "Do you o'Really? [y/N]: ". If the user press 'y' will pass (return true), if 'n', 'enter' and 'backspace' will return false. Invalid characters will print a short error message.

Parameters:

what - What to confirm. Basically the message before '[Y/n]'.

def - the default response on 'enter'.

Returns:

Confirmation result.

executeAbortable

public <T> T executeAbortable(ExecutorService exec,
                              Callable<T> callable)
                       throws IOException,
                              InterruptedException,
                              ExecutionException

Execute callable, which may not be interruptable by itself, but listen to terminal input and abort the task if CTRL-C is pressed.

Type Parameters:

T - The return type of the callable.

Parameters:

exec - The executor to run task on.

callable - The callable function.

Returns:

The result of the callable.

Throws:

IOException - If aborted or read failure.

InterruptedException - If interrupted while waiting.

ExecutionException - If execution failed.

executeAbortable

public void executeAbortable(ExecutorService exec,
                             Runnable callable)
                      throws IOException,
                             InterruptedException,
                             ExecutionException

Execute runnable, which may not be interruptable by itself, but listen to terminal input and abort the task if CTRL-C is pressed.

Parameters:

exec - The executor to run task on.

callable - The runnable function.

Throws:

IOException - If aborted or read failure.

InterruptedException - If interrupted while waiting.

ExecutionException - If execution failed.

waitAbortable

public <T> void waitAbortable(Future<T> task)
                       throws IOException,
                              InterruptedException

Wait for future task to be done or canceled. React to terminal induced abort (ctrl-C) and cancel the task if so.

Type Parameters:

T - The task generic type.

Parameters:

task - The task to wait for.

Throws:

IOException - On aborted or read failure.

InterruptedException - On thread interrupted.

format

public void format(String format,
                   Object... args)

print

public void print(Char ch)

print

public void print(String message)

println

public void println(String message)

Description copied from interface: LinePrinter

Print a new line to the terminal.

Specified by:

println in interface LinePrinter

Parameters:

message - The message to write.

println

public void println()

finish

public void finish()

Finish the current set of lines and continue below.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getOutputStream

protected OutputStream getOutputStream()

sleep

protected void sleep(long millis)
              throws InterruptedException

Throws:

InterruptedException