Package com.calebleavell.jatui.modules

Class FunctionModule.Builder

java.lang.Object

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

com.calebleavell.jatui.modules.FunctionModule.Builder

All Implemented Interfaces:

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

Enclosing class:

FunctionModule

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

Builder for FunctionModule.

Required fields: name, function

Nested Class Summary

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

DirectedGraphNode.PropertyUpdateFlag

Field Summary

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, Runnable function)	Constructs a builder based on a provided name and Runnable.
protected	Builder(String name, Supplier<?> function)	Constructs a builder based on a provided name and Supplier

Method Summary

Modifier and Type	Method	Description
FunctionModule	build()	Builds a new FunctionModule based on this builder.
protected FunctionModule.Builder	createInstance()	Gets a fresh instance of this type of Builder.
FunctionModule.Builder	function(Runnable function)	The function is the Supplier logic that this module will execute when it is run.
FunctionModule.Builder	function(Supplier<?> function)	The function is the Supplier logic that this module will execute when it is run.
Supplier<?>	getFunction()	The function is the Supplier logic that this module will execute when it is run.
void	shallowCopy(FunctionModule.Builder original)	Creates a copy of original by mutating this instance.

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, shallowStructuralEquals, 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

Constructor Details

Builder

protected Builder(String name,
 Supplier<?> function)

Constructs a builder based on a provided name and Supplier

Parameters:

name - The unique name of the module

function - The Supplier that will be executed when this module is built and run.

Builder

protected Builder(String name,
 Runnable function)

Constructs a builder based on a provided name and Runnable. Note that the Runnable will get wrapped in a Supplier that returns null

Parameters:

name - The unique name of the module

function - The Runnable that will be executed when this module is built and run.

Builder

protected Builder()

Method Details

getFunction

public Supplier<?> getFunction()

The function is the Supplier logic that this module will execute when it is run.

Returns:

The function stored by this module.

function

public FunctionModule.Builder function(Supplier<?> function)

The function is the Supplier logic that this module will execute when it is run.

Parameters:

function - The Supplier to be run when this module is run

Returns:

self

function

public FunctionModule.Builder function(Runnable function)

The function is the Supplier logic that this module will execute when it is run.

Parameters:

function - The Runnable to be run when this module is run (this will be wrapped in a Supplier that returns null.)

Returns:

self

createInstance

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

Returns:

A fresh, empty instance.

shallowCopy

public void shallowCopy(FunctionModule.Builder original)

Creates a copy of original by mutating this instance. Children are not copied. This is a utility method for TUIModule.Builder.getCopy()

Overrides:

shallowCopy in class TUIModule.Builder<FunctionModule.Builder>

Parameters:

original - The builder to copy from

build

public FunctionModule build()

Builds a new FunctionModule based on this builder.

Specified by:

build in class TUIModule.Builder<FunctionModule.Builder>

Returns:

The built FunctionModule