org.beryx.textio.mock

Class MockTerminal

java.lang.Object

org.beryx.textio.mock.MockTerminal

All Implemented Interfaces:

TextTerminal<MockTerminal>

public class MockTerminal
extends Object
implements TextTerminal<MockTerminal>

A mock terminal for test purposes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_READS

Constructor Summary

Constructors

Constructor and Description
MockTerminal()

Method Summary

Modifier and Type	Method and Description
List<String>	getInputs()
int	getMaxReads()
String	getOutput()
int	getReadCalls()
void	println() Terminates the current line by writing the line separator string.
void	rawPrint(String message) Prints the message in its raw form.
String	read(boolean masking) Reads a line of text
boolean	registerUserInterruptHandler(Consumer<MockTerminal> handler, boolean abortRead) Registers a handler that will be called in response to a user interrupt.
void	setMaxReads(int maxReads)
static String	stripAll(String text)

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, print, print, printf, printf, println, println, rawPrint

Field Detail

DEFAULT_MAX_READS

public static final int DEFAULT_MAX_READS

See Also:

Constant Field Values

Constructor Detail

MockTerminal

public MockTerminal()

Method Detail

read

public String read(boolean masking)

Description copied from interface: TextTerminal

Reads a line of text

Specified by:

read in interface TextTerminal<MockTerminal>

Parameters:

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

Returns:

the entered text

rawPrint

public void rawPrint(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.

Specified by:

rawPrint in interface TextTerminal<MockTerminal>

println

public void println()

Description copied from interface: TextTerminal

Terminates the current line by writing the line separator string.

Specified by:

println in interface TextTerminal<MockTerminal>

getInputs

public List<String> getInputs()

getOutput

public String getOutput()

getReadCalls

public int getReadCalls()

getMaxReads

public int getMaxReads()

setMaxReads

public void setMaxReads(int maxReads)

stripAll

public static String stripAll(String text)

registerUserInterruptHandler

public boolean registerUserInterruptHandler(Consumer<MockTerminal> 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.

Specified by:

registerUserInterruptHandler in interface TextTerminal<MockTerminal>

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.