Package com.calebleavell.jatui.modules

Class TextModule.Builder

java.lang.Object

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

com.calebleavell.jatui.modules.TextModule.Builder

All Implemented Interfaces:

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

Enclosing class:

TextModule

public static class TextModule.Builder
extends TUIModule.Builder<TextModule.Builder>

Builder for TextInputModule.

Required fields: name, text
Optional fields (with default values): printNewLine, outputType

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 TextModule.OutputType	outputType	The TextModule.OutputType of the text to display, which includes pure output or fetching application state.
protected boolean	printNewLine	Whether to print a new line after the text is outputted.
protected String	text	The text to either display directly or the input identifier fetch the input from for the ApplicationModule.

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	Builder()
protected	Builder(String name, String text)

Method Summary

Modifier and Type	Method	Description
TextModule.Builder	append(String text)	Append to the text that's already been configured for this builder.
TextModule	build()	Builds a new TextModule based on the configuration of this builder.
protected TextModule.Builder	createInstance()	Gets a fresh instance of this type of Builder.
TextModule.OutputType	getOutputType()	Get the TextModule.OutputType that defines the behavior of this module.
boolean	getPrintNewLine()	If printNewLine is true, this module prints a new line after outputting.
String	getText()	Get the text that defines how this module outputs.
TextModule.Builder	outputType(TextModule.OutputType type)	Set the TextModule.OutputType that defines the behavior of this module.
TextModule.Builder	printNewLine(boolean printNewLine)	If true, this module prints a new line after outputting.
void	shallowCopy(TextModule.Builder original)	Copies text, printNewLine, and outputType, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).
boolean	shallowStructuralEquals(TextModule.Builder first, TextModule.Builder second)	Checks equality for properties given by the builder.
TextModule.Builder	text(String text)	Set the text that defines how this module outputs.

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

addChild, addChild, addChildren, addChildren, appendStyle, application, clearChildren, deepCopy, 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

text

protected String text

The text to either display directly or the input identifier fetch the input from for the ApplicationModule.

printNewLine

protected boolean printNewLine

Whether to print a new line after the text is outputted.

outputType

protected TextModule.OutputType outputType

The TextModule.OutputType of the text to display, which includes pure output or fetching application state.

Constructor Details

Builder

protected Builder(String name,
 String text)

Builder

protected Builder()

Method Details

createInstance

protected TextModule.Builder 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<TextModule.Builder>

Returns:

A fresh, empty instance.

shallowCopy

public void shallowCopy(TextModule.Builder original)

Copies text, printNewLine, and outputType, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).

Overrides:

shallowCopy in class TUIModule.Builder<TextModule.Builder>

Parameters:

original - The builder to copy from.

printNewLine

public TextModule.Builder printNewLine(boolean printNewLine)

If true, this module prints a new line after outputting.

Parameters:

printNewLine - Whether to print a new line after outputting.

Returns:

self

getPrintNewLine

public boolean getPrintNewLine()

If printNewLine is true, this module prints a new line after outputting.

Returns:

printNewLine

outputType

public TextModule.Builder outputType(TextModule.OutputType type)

Set the TextModule.OutputType that defines the behavior of this module.

Parameters:

type - the output type of this module.

Returns:

self

getOutputType

public TextModule.OutputType getOutputType()

Get the TextModule.OutputType that defines the behavior of this module.

Returns:

the output type of this module.

text

public TextModule.Builder text(String text)

Set the text that defines how this module outputs.

Parameters:

text - What to output.

Returns:

self.

append

public TextModule.Builder append(String text)

Append to the text that's already been configured for this builder.

Parameters:

text - What to append to the existing text.

Returns:

self

getText

public String getText()

Get the text that defines how this module outputs.

Returns:

What to output.

shallowStructuralEquals

public boolean shallowStructuralEquals(TextModule.Builder first,
 TextModule.Builder second)

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).

Specified by:

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

Overrides:

shallowStructuralEquals in class TUIModule.Builder<TextModule.Builder>

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

build

public TextModule build()

Builds a new TextModule based on the configuration of this builder.

Specified by:

build in class TUIModule.Builder<TextModule.Builder>

Returns:

The new TextModule.