org.beryx.textio.console

Class ConsoleTextTerminal

java.lang.Object

org.beryx.textio.AbstractTextTerminal<ConsoleTextTerminal>

org.beryx.textio.console.ConsoleTextTerminal

All Implemented Interfaces:

TextTerminal<ConsoleTextTerminal>

public class ConsoleTextTerminal
extends AbstractTextTerminal<ConsoleTextTerminal>

A TextTerminal backed by a Console.

Field Summary

Fields inherited from class org.beryx.textio.AbstractTextTerminal

DEFAULT_USER_INTERRUPT_KEY, SYSPROP_PROPERTIES_FILE_LOCATION

Constructor Summary

Constructors

Constructor and Description
ConsoleTextTerminal()
ConsoleTextTerminal(java.io.Console console)

Method Summary

Modifier and Type	Method and Description
void	println() Terminates the current line by writing the line separator string.
void	rawPrint(java.lang.String message) Prints the message in its raw form.
java.lang.String	read(boolean masking) Reads a line of text
boolean	registerUserInterruptHandler(java.util.function.Consumer<ConsoleTextTerminal> handler, boolean abortRead) Registers a handler that will be called in response to a user interrupt.

Methods inherited from class org.beryx.textio.AbstractTextTerminal

addDefaultProperty, getDefaultProperties, getProperties, getPropertiesPrefixes, getPropertiesReader, init, initProperties, initProperties, initProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.beryx.textio.TextTerminal

abort, dispose, dispose, print, print, printf, printf, println, println, rawPrint, resetLine, resetToBookmark, setBookmark

Constructor Detail

ConsoleTextTerminal

public ConsoleTextTerminal()

ConsoleTextTerminal

public ConsoleTextTerminal(java.io.Console console)

Method Detail

read

public java.lang.String read(boolean masking)

Description copied from interface: TextTerminal

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

public void rawPrint(java.lang.String message)

Description copied from interface: TextTerminal

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

public void println()

Description copied from interface: TextTerminal

Terminates the current line by writing the line separator string.

registerUserInterruptHandler

public boolean registerUserInterruptHandler(java.util.function.Consumer<ConsoleTextTerminal> handler,
                                            boolean abortRead)

Description copied from interface: TextTerminal

Registers a handler that will be called in response to a user interrupt. The event that triggers a user interrupt is usually Ctrl+C, but in general it is terminal specific. For example, a Swing based terminal may send a user interrupt when the X close button of its window is hit. If a terminal is not able to register user interrupt handlers, it should return false.

Parameters:

handler - the action to be performed in response to a user interrupt.

abortRead - true, if the current read operation should be aborted on user interrupt.

Returns:

true, if the handler has been registered; false, otherwise.