Package com.calebleavell.jatui.modules

Class TextModule

java.lang.Object

com.calebleavell.jatui.modules.TUIModule

com.calebleavell.jatui.modules.TextModule

public class TextModule
extends TUIModule

Handles the displaying of text. Usually this means displaying to console (System.out), but TUIModule.Builder.printStream(PrintStream) can be used to output to other places as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextModule.Builder	Builder for TextInputModule.
static enum	TextModule.OutputType	Defines the behavior of the TextModule, specifically whether it displays raw text or fetches application state.

Nested classes/interfaces inherited from class com.calebleavell.jatui.modules.TUIModule

TUIModule.Property

Field Summary

Fields inherited from class com.calebleavell.jatui.modules.TUIModule

DEFAULT_SCANNER, logger, restart, UNNAMED_ERROR

Constructor Summary

Constructors

Constructor	Description
TextModule(TextModule.Builder builder)	Constructs a new TextModule based on the configuration of the TextModule.Builder.

Method Summary

Modifier and Type	Method	Description
static TextModule.Builder	builder(String name, String text)	Constructs a new TextModule builder.
void	doRunLogic()	Outputs text via the behavior given by TextModule.OutputType.
boolean	equals(TextModule other)	Checks equality for properties given by the builder.

Methods inherited from class com.calebleavell.jatui.modules.TUIModule

getAnsi, getAnsiEnabled, getApplication, getChild, getChild, getChildren, getCurrentRunningBranch, getCurrentRunningChild, getCurrentRunningChild, getName, getPrintStream, getScanner, navigateTo, restart, restartChild, shallowStructuralEquals, start, structuralEquals, terminate, terminateChild, toString, toTreeString, toTreeString

Methods inherited from class java.lang.Object

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

Constructor Details

TextModule

public TextModule(TextModule.Builder builder)

Constructs a new TextModule based on the configuration of the TextModule.Builder. Copies text, printNewLine, and outputType from the builder.

Parameters:

builder - The builder to construct the new module from.

Method Details

doRunLogic

public void doRunLogic()

Outputs text via the behavior given by TextModule.OutputType. If application is null and TextModule.OutputType is TextModule.OutputType.DISPLAY_APP_STATE, nothing is outputted and a warning is logged.
Also displays the ansi provided by TUIModule.Builder.style(Ansi) unless disabled via TUIModule.Builder.enableAnsi(boolean). The ansi gets reset at the end of the run.
Prints a new line unless disabled via TextModule.Builder.printNewLine(boolean).

Specified by:

doRunLogic in class TUIModule

equals

public boolean equals(TextModule other)

Checks equality for properties given by the builder. For TextModule, this includes text, printNewLine, and outputType, as well as other requirements provided by TUIModule.structuralEquals(TUIModule).

builder

public static TextModule.Builder builder(String name,
 String text)

Constructs a new TextModule builder.

Parameters:

name - The name of the builder.

text - The text to either display directly, or the input identifier fetch the input from for the ApplicationModule if TextModule.Builder.outputType(OutputType) is set to TextModule.OutputType.DISPLAY_APP_STATE.

Returns:

The new builder.