org.beryx.textio

Interface TextTerminal

All Known Implementing Classes:

AnsiTextTerminal, ConsoleTextTerminal, JLineTextTerminal, SwingTextTerminal, SystemTextTerminal, WebTextTerminal

public interface TextTerminal

Interface for text-based terminals capable of reading (optionally masking the input) and writing text.

Method Summary

Modifier and Type	Method and Description
default void	dispose() This method is typically called at the end of a text-based input/output session in order to allow the terminal to release its screen resources.
default void	print(List<String> messages) Prints each message in the list, inserting the line separator string between messages.
default void	print(String message) Prints a message that possibly contains line separators.
default void	printf(Locale l, String format, Object... args)
default void	printf(String format, Object... args)
void	println() Terminates the current line by writing the line separator string.
default void	println(List<String> messages) Prints each message in the list, inserting the line separator string between messages.
default void	println(String message) Prints a message that possibly contains line separators and subsequently prints a line separator.
default void	rawPrint(List<String> messages) Prints each message in the list in its raw form, inserting the line separator string between messages.
void	rawPrint(String message) Prints the message in its raw form.
String	read(boolean masking) Reads a line of text

Method Detail

read

String read(boolean masking)

Reads a line of text

Parameters:

masking - true, if the input should be masked (for example to enter a password)

Returns:

the entered text

rawPrint

void rawPrint(String message)

Prints the message in its raw form. This method expects a single line of text. The behavior is undefined if the string contains line separators.

println

void println()

Terminates the current line by writing the line separator string.

dispose

default void dispose()

This method is typically called at the end of a text-based input/output session in order to allow the terminal to release its screen resources. The terminal should be able to rebuild the released resources when a print or read method is subsequently called. The default implementation does nothing.

rawPrint

default void rawPrint(List<String> messages)

Prints each message in the list in its raw form, inserting the line separator string between messages. No separator string is printed after the last message. The behavior is undefined if one or more strings in the list contain line separators.

print

default void print(String message)

Prints a message that possibly contains line separators.

println

default void println(String message)

Prints a message that possibly contains line separators and subsequently prints a line separator.

print

default void print(List<String> messages)

Prints each message in the list, inserting the line separator string between messages. No separator string is printed after the last message. The messages in the list may contain line separators.

println

default void println(List<String> messages)

Prints each message in the list, inserting the line separator string between messages. A separator string is also printed after the last message. The messages in the list may contain line separators.

printf

default void printf(String format,
                    Object... args)

printf

default void printf(Locale l,
                    String format,
                    Object... args)