Package com.calebleavell.jatui.templates

Class TextChain

java.lang.Object

com.calebleavell.jatui.modules.TUIModule.Builder<TextChain>

com.calebleavell.jatui.modules.ModuleTemplate<TextChain>

com.calebleavell.jatui.templates.TextChain

All Implemented Interfaces:

DirectedGraphNode<TUIModule.Property,TUIModule.Builder<?>,TextChain>

public class TextChain
extends ModuleTemplate<TextChain>

Simplifies chaining text together that is meant to live on the same line. Ansi is supported with method overloads (e.g., addText(String, Ansi)).

Usage:

 LineBuilder text = LineBuilder.builder("name")
     .addText("Regular text: ")
     // this will display what the inputted module outputs
     .addModuleOutput("This string is the name of another module")
     .newLine() // end of line 1
     .addText("Text on the next line.")
     .newLine(); // end of line 2
 

Nested Class Summary

Nested classes/interfaces inherited from interface com.calebleavell.jatui.core.DirectedGraphNode

DirectedGraphNode.PropertyUpdateFlag

Field Summary

Fields

Modifier and Type	Field	Description
protected int	iterator	Appended to the name of every new TextModule and incremented.

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

main

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

ansi, application, children, enableAnsi, logger, name, printStream, propertyUpdateFlags, scanner, type, usedNames

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextChain()
protected	TextChain(String name)

Method Summary

Modifier and Type	Method	Description
TextChain	addModuleOutput(String moduleName)	Displays the output of the module with name moduleName.
TextChain	addModuleOutput(String moduleName, org.fusesource.jansi.Ansi ansi)	Displays the output of the module with name moduleName.
TextChain	addText(TextModule.Builder text)	Adds text as a child of this module.
TextChain	addText(String text)	Adds a new TextModule as a child of this module.
TextChain	addText(String text, org.fusesource.jansi.Ansi ansi)	Adds a new TextModule as a child of this module.
static TextChain	builder(String name)	Constructs a new TextChain builder.
protected TextChain	createInstance()	Gets a fresh instance of this type of Builder.
protected TextModule.Builder	getCurrent()	current is a reference of the most recently added text is saved to call TextModule.Builder.printNewLine(boolean) if newLine() is called.
TextChain	newLine()	Prints an os-defined newline.
void	shallowCopy(TextChain original)	Copies the reference to the most recently added module and the naming iterator, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).
boolean	shallowStructuralEquals(TextChain first, TextChain second)	Checks equality for properties given by the builder.

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

build, deepCopy

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

addChild, addChild, addChildren, addChildren, appendStyle, application, clearChildren, deepCopy, enableAnsi, getAnsi, getAnsiEnabled, getApplication, getChild, getChild, getChildren, getCopy, getDeepCopy, getName, getPrintStream, getPropertyUpdateFlags, getScanner, getType, lockProperty, name, prependStyle, prependToName, printStream, scanner, self, structuralEquals, style, toString, unlockProperty, updateFlag, updateProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.calebleavell.jatui.core.DirectedGraphNode

abstractSelf, containsNullNode, containsNullNode, dfs, dfs, forEach, forEachChild, structuralEquals, structuralEquals, updateProperty, updateProperty

Field Details

iterator

protected int iterator

Appended to the name of every new TextModule and incremented. The name of every text module follows "[LineBuilder name]-main-[iterator]".

Constructor Details

TextChain

protected TextChain(String name)

TextChain

protected TextChain()

Method Details

builder

public static TextChain builder(String name)

Constructs a new TextChain builder.

Parameters:

name - The name of the builder.

Returns:

The new builder.

createInstance

protected TextChain createInstance()

Gets a fresh instance of this type of Builder. Note, this is intended only for copying utility and may have unknown consequences if used in other ways.

Specified by:

createInstance in class TUIModule.Builder<TextChain>

Returns:

A fresh, empty instance.

shallowCopy

public void shallowCopy(TextChain original)

Copies the reference to the most recently added module and the naming iterator, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).

Overrides:

shallowCopy in class TUIModule.Builder<TextChain>

Parameters:

original - The builder to copy from.

addText

public TextChain addText(TextModule.Builder text)

Adds text as a child of this module.

Parameters:

text - The TextModule to add.

Returns:

self

Implementation Note:

Adds text as a child of main rather than directly to this module.

addText

public TextChain addText(String text,
 org.fusesource.jansi.Ansi ansi)

Adds a new TextModule as a child of this module. To print a new line after this text, call newLine().

Parameters:

text - The text to add.

ansi - The Ansi that this text may use. Ansi is reset automatically after text is displayed.

Returns:

self.

addText

public TextChain addText(String text)

Adds a new TextModule as a child of this module. To print a new line after this text, call newLine().

Parameters:

text - The text to add.

Returns:

self.

addModuleOutput

public TextChain addModuleOutput(String moduleName,
 org.fusesource.jansi.Ansi ansi)

Displays the output of the module with name moduleName. More precisely, it displays the application state that is accessed at ApplicationModule.getInput(String).

Parameters:

moduleName - The input identifier for the application state (likely the name of another module).

ansi - The Ansi that this text may use. Ansi is reset automatically after text is displayed.

Returns:

self

Implementation Note:

Wraps TextModule.OutputType.DISPLAY_APP_STATE.

addModuleOutput

public TextChain addModuleOutput(String moduleName)

Displays the output of the module with name moduleName. More precisely, it displays the application state that is accessed at ApplicationModule.getInput(String).

Parameters:

moduleName - The input identifier for the application state (likely the name of another module).

Returns:

self

Implementation Note:

Wraps TextModule.OutputType.DISPLAY_APP_STATE.

newLine

public TextChain newLine()

Prints an os-defined newline.

Example:

 LineBuilder text = LineBuilder.builder("name")
     .newLine()
     .addText("Hello, ")
     .addText("World!")
     .newLine();

 text.build().run();

 // output: "\nHello, World!\n"
 

Returns:

self

Implementation Note:

If text has been added, it sets the most recently added TextModule to print a newline. If not, it adds a new empty TextModule and sets it to print a newline. TextModule uses PrintStream.println().

getCurrent

protected TextModule.Builder getCurrent()

current is a reference of the most recently added text is saved to call TextModule.Builder.printNewLine(boolean) if newLine() is called.

Returns:

current;

shallowStructuralEquals

public boolean shallowStructuralEquals(TextChain first,
 TextChain second)

Checks equality for properties given by the builder. For TextChain, this includes current and iterator, as well as other requirements provided by TUIModule.Builder.shallowStructuralEquals(TUIModule.Builder, TUIModule.Builder).

Specified by:

shallowStructuralEquals in interface DirectedGraphNode<TUIModule.Property,TUIModule.Builder<?>,TextChain>

Overrides:

shallowStructuralEquals in class TUIModule.Builder<TextChain>

Parameters:

first - The first TUIModule to compare

second - The second TUIModule to compare

Returns:

true if first and second are equal according to builder-provided properties