net.morimekta.console

Class Terminal

java.lang.Object

net.morimekta.console.chr.CharReader

net.morimekta.console.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(InputStream in, OutputStream out, LinePrinter lp, STTYModeSwitcher switcher) Constructor visible for testing.
Terminal(LinePrinter lp) Construct a terminal with a custom line printer.
Terminal(STTYMode mode) Construct a terminal with given mode.
Terminal(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.
void	finish() Finish the current set of lines and continue below.
void	format(String format, Object... args)
void	formatln(String format, Object... args)
void	print(Char ch)
void	print(String message)
void	println()
void	println(String message) Print a new line to the terminal.

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

read

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.LinePrinter

error, fatal, info, warn

Constructor Detail

Terminal

public Terminal()

Construct a default RAW terminal.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

public Terminal(STTYMode mode)

Construct a terminal with given mode.

Parameters:

mode - The terminal mode.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

public Terminal(LinePrinter lp)

Construct a terminal with a custom line printer.

Parameters:

lp - The line printer.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

public Terminal(STTYMode mode,
                LinePrinter lp)

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

Parameters:

mode - The terminal mode.

lp - The line printer.

Throws:

UncheckedIOException - If unable to set TTY mode.

Terminal

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

Constructor visible for testing.

Parameters:

in - The input stream.

out - The output stream.

lp - The line printer or null.

switcher - The TTY mode switcher.

Throws:

UncheckedIOException - If unable to set TTY mode.

Method Detail

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.

format

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

formatln

public void formatln(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