Package com.calebleavell.jatui.templates

Class ConfirmationPrompt

java.lang.Object

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

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

com.calebleavell.jatui.templates.ConfirmationPrompt

All Implemented Interfaces:

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

public class ConfirmationPrompt
extends ModuleTemplate<ConfirmationPrompt>

Handles getting confirmation from the user. Includes specifying allowed responses (y/yes/n/no) by default, as well on what to do when the user confirms or denies.

Example Usage:

             ConfirmationPrompt confirmExit = ConfirmationPrompt.builder("confirm-exit",
                 "Are you sure you want to exit (y/n)? ")
                 .setApplication(app)
                 .addOnConfirm(app::terminate)
                 .addOnDeny(app::restart);
 

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.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	ConfirmationPrompt()
protected	ConfirmationPrompt(String name, String displayText)

Method Summary

Modifier and Type	Method	Description
ConfirmationPrompt	addOnConfirm(Runnable logic)	Specifies what to do when the user confirms.
ConfirmationPrompt	addOnConfirm(String name, Supplier<?> logic)	Specifies what to do when the user confirms.
ConfirmationPrompt	addOnDeny(Runnable logic)	Specifies what to do when the user denies.
ConfirmationPrompt	addOnDeny(String name, Supplier<?> logic)	Specifies what to do when the user denies.
static ConfirmationPrompt	builder(String name, String displayText)	Constructs a new ConfirmationPrompt builder.
protected ConfirmationPrompt	createInstance()	Gets a fresh instance of this type of Builder.
Set<String>	getValidConfirm()	Gets the inputs that are considered confirmation from the user (yes/y) by default.
Set<String>	getValidDeny()	Gets the inputs that are considered denial from the user (no/n) by default.
ConfirmationPrompt	name(String name)	Sets the name as provided by TUIModule.Builder.name(String).
void	shallowCopy(ConfirmationPrompt original)	Copies valid confirmation and denial inputs, the current iters for naming handlers, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).
boolean	shallowStructuralEquals(ConfirmationPrompt first, ConfirmationPrompt second)	Checks equality for properties given by the builder.
ConfirmationPrompt	validConfirm(String... confirmStrings)	Sets the strings that will count as a confirmation.
ConfirmationPrompt	validDeny(String... denyStrings)	Sets the strings that will count as a denial.

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

Constructor Details

ConfirmationPrompt

protected ConfirmationPrompt(String name,
 String displayText)

ConfirmationPrompt

protected ConfirmationPrompt()

Method Details

builder

public static ConfirmationPrompt builder(String name,
 String displayText)

Constructs a new ConfirmationPrompt builder.

Parameters:

name - The name of the builder.

displayText - The text that displays before getting input (e.g., "Are you sure? ").

Returns:

The new builder.

createInstance

protected ConfirmationPrompt 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<ConfirmationPrompt>

Returns:

A fresh, empty instance.

validConfirm

public ConfirmationPrompt validConfirm(String... confirmStrings)

Sets the strings that will count as a confirmation. Note, this clears the current confirmation strings.
Note: spaces are stripped from both these strings and the input, and both these strings and the input are converted to lowercase.

Parameters:

confirmStrings - The strings that count as confirmation

Returns:

self

getValidConfirm

public Set<String> getValidConfirm()

Gets the inputs that are considered confirmation from the user (yes/y) by default.

Returns:

The valid confirmation strings.

validDeny

public ConfirmationPrompt validDeny(String... denyStrings)

Sets the strings that will count as a denial. Note, this clears the current denial strings
Note: spaces are stripped from both these strings and the input, and both these strings and the input are converted to lowercase.

Parameters:

denyStrings - The strings that count as denial

Returns:

self

getValidDeny

public Set<String> getValidDeny()

Gets the inputs that are considered denial from the user (no/n) by default.

Returns:

The valid denial strings.

addOnConfirm

public ConfirmationPrompt addOnConfirm(Runnable logic)

Specifies what to do when the user confirms.

Parameters:

logic - The logic to run on the input.

Returns:

self

addOnConfirm

public ConfirmationPrompt addOnConfirm(String name,
 Supplier<?> logic)

Specifies what to do when the user confirms.

Parameters:

name - The input identifier to access what logic returns (ApplicationModule.getInput(String)).

logic - The logic to run on the input.

Returns:

self

addOnDeny

public ConfirmationPrompt addOnDeny(String name,
 Supplier<?> logic)

Specifies what to do when the user denies.

Parameters:

name - The input identifier to access what logic returns (ApplicationModule.getInput(String)).

logic - The logic to run on the input.

Returns:

self

addOnDeny

public ConfirmationPrompt addOnDeny(Runnable logic)

Specifies what to do when the user denies.

Parameters:

logic - The logic to run on the input.

Returns:

self

name

public ConfirmationPrompt name(String name)

Sets the name as provided by TUIModule.Builder.name(String). Also updates the name of the input module to ensure correct input handling.

Overrides:

name in class TUIModule.Builder<ConfirmationPrompt>

Parameters:

name - The unique name of this module.

Returns:

self

shallowStructuralEquals

public boolean shallowStructuralEquals(ConfirmationPrompt first,
 ConfirmationPrompt second)

Checks equality for properties given by the builder. For ConfirmationPrompt, this includes confirm, deny, confirmIter, and denyIter, as well as other requirements provided by TUIModule.Builder.shallowStructuralEquals(TUIModule.Builder, TUIModule.Builder).

Specified by:

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

Overrides:

shallowStructuralEquals in class TUIModule.Builder<ConfirmationPrompt>

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

shallowCopy

public void shallowCopy(ConfirmationPrompt original)

Copies valid confirmation and denial inputs, the current iters for naming handlers, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).

Overrides:

shallowCopy in class TUIModule.Builder<ConfirmationPrompt>

Parameters:

original - The builder to copy from.