Module org.jline.prompt

Package org.jline.prompt.impl

Class DefaultConfirmBuilder

java.lang.Object

org.jline.prompt.impl.DefaultConfirmBuilder

All Implemented Interfaces:

BaseBuilder<ConfirmBuilder>, ConfirmBuilder

public class DefaultConfirmBuilder
extends Object
implements ConfirmBuilder

Default implementation of ConfirmBuilder. This is now the native implementation that doesn't depend on console-ui.

Constructor Summary

Constructors

Constructor	Description
DefaultConfirmBuilder(PromptBuilder parent)	Create a new DefaultConfirmBuilder with the given parent.

Method Summary

Modifier and Type	Method	Description
PromptBuilder	addPrompt()	Add this prompt to the parent builder.
ConfirmBuilder	defaultValue(boolean defaultValue)	Set the default value.
ConfirmBuilder	filter(Function<String,String> filter)	Set a filter function that modifies the actual returned value.
ConfirmBuilder	message(String message)	Set the message to display to the user.
ConfirmBuilder	name(String name)	Set the name of this prompt.
ConfirmBuilder	transformer(Function<String,String> transformer)	Set a transformer function that modifies how the answer is displayed after submission.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultConfirmBuilder

public DefaultConfirmBuilder(PromptBuilder parent)

Create a new DefaultConfirmBuilder with the given parent.

Parameters:

parent - the parent builder

Method Details

name

public ConfirmBuilder name(String name)

Set the name of this prompt.

Specified by:

name in interface BaseBuilder<ConfirmBuilder>

Parameters:

name - the name

Returns:

this builder

message

public ConfirmBuilder message(String message)

Set the message to display to the user.

Specified by:

message in interface BaseBuilder<ConfirmBuilder>

Parameters:

message - the message

Returns:

this builder

defaultValue

public ConfirmBuilder defaultValue(boolean defaultValue)

Set the default value.

Specified by:

defaultValue in interface ConfirmBuilder

Parameters:

defaultValue - the default value

Returns:

this builder

transformer

public ConfirmBuilder transformer(Function<String,String> transformer)

Description copied from interface: BaseBuilder

Set a transformer function that modifies how the answer is displayed after submission. This does not change the actual returned value. For example, a password prompt might transform the answer to "***".

Specified by:

transformer in interface BaseBuilder<ConfirmBuilder>

Parameters:

transformer - the transformer function

Returns:

this builder instance for method chaining

filter

public ConfirmBuilder filter(Function<String,String> filter)

Description copied from interface: BaseBuilder

Set a filter function that modifies the actual returned value. This changes the value stored in the result map. For example, trimming whitespace or converting to lowercase.

Specified by:

filter in interface BaseBuilder<ConfirmBuilder>

Parameters:

filter - the filter function

Returns:

this builder instance for method chaining

addPrompt

public PromptBuilder addPrompt()

Add this prompt to the parent builder.

Specified by:

addPrompt in interface BaseBuilder<ConfirmBuilder>

Returns:

the parent PromptBuilder for continued prompt configuration

See Also:

• PromptBuilder.build()