- java.lang.Object
-
- org.jline.prompt.impl.DefaultToggleBuilder
-
- All Implemented Interfaces:
BaseBuilder<ToggleBuilder>,ToggleBuilder
public class DefaultToggleBuilder extends java.lang.Object implements ToggleBuilder
Default implementation of ToggleBuilder.
-
-
Constructor Summary
Constructors Constructor Description DefaultToggleBuilder(PromptBuilder parent)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ToggleBuilderactiveLabel(java.lang.String label)Set the label for the active (on) state.PromptBuilderaddPrompt()Complete the configuration of this prompt and add it to the parent builder.ToggleBuilderdefaultValue(boolean defaultValue)Set the default value.ToggleBuilderfilter(java.util.function.Function<java.lang.String,java.lang.String> filter)Set a filter function that modifies the actual returned value.ToggleBuilderinactiveLabel(java.lang.String label)Set the label for the inactive (off) state.ToggleBuildermessage(java.lang.String message)Set the message displayed to the user for this prompt.ToggleBuildername(java.lang.String name)Set the unique identifier for this prompt.ToggleBuildertransformer(java.util.function.Function<java.lang.String,java.lang.String> transformer)Set a transformer function that modifies how the answer is displayed after submission.
-
-
-
Constructor Detail
-
DefaultToggleBuilder
public DefaultToggleBuilder(PromptBuilder parent)
-
-
Method Detail
-
name
public ToggleBuilder name(java.lang.String name)
Description copied from interface:BaseBuilderSet the unique identifier for this prompt.The name serves as the key in the result map returned by
Prompter.prompt(java.util.List<org.jline.utils.AttributedString>, java.util.List<? extends org.jline.prompt.Prompt>). It must be unique within a single prompt session to avoid conflicts.Naming Guidelines:
- Use descriptive, lowercase names with underscores:
"user_name","file_path" - Avoid spaces and special characters
- Keep names concise but meaningful
- Use consistent naming conventions across your application
Example:
builder.createInputPrompt() .name("email_address") // Used as key in results map .message("Enter your email:") .addPrompt(); // Later access the result InputResult emailResult = (InputResult) results.get("email_address");- Specified by:
namein interfaceBaseBuilder<ToggleBuilder>- Parameters:
name- the unique identifier for this prompt (required, non-null, non-empty)- Returns:
- this builder instance for method chaining
- Use descriptive, lowercase names with underscores:
-
message
public ToggleBuilder message(java.lang.String message)
Description copied from interface:BaseBuilderSet the message displayed to the user for this prompt.The message is the primary text that explains what the user should do. It should be clear, concise, and provide sufficient context for the user to understand what input is expected.
Message Guidelines:
- Use clear, actionable language: "Select your preferred option"
- End with appropriate punctuation (colon for selections, question mark for questions)
- Keep messages concise but informative
- Consider the terminal width for longer messages
Examples:
- List prompt:
"Choose your preferred IDE:" - Input prompt:
"Enter your full name:" - Confirm prompt:
"Do you want to continue?" - Checkbox prompt:
"Select features to enable:"
- Specified by:
messagein interfaceBaseBuilder<ToggleBuilder>- Parameters:
message- the message to display to the user (required, non-null, non-empty)- Returns:
- this builder instance for method chaining
-
activeLabel
public ToggleBuilder activeLabel(java.lang.String label)
Description copied from interface:ToggleBuilderSet the label for the active (on) state.- Specified by:
activeLabelin interfaceToggleBuilder- Parameters:
label- the active state label (default: "Yes")- Returns:
- this builder
-
inactiveLabel
public ToggleBuilder inactiveLabel(java.lang.String label)
Description copied from interface:ToggleBuilderSet the label for the inactive (off) state.- Specified by:
inactiveLabelin interfaceToggleBuilder- Parameters:
label- the inactive state label (default: "No")- Returns:
- this builder
-
defaultValue
public ToggleBuilder defaultValue(boolean defaultValue)
Description copied from interface:ToggleBuilderSet the default value.- Specified by:
defaultValuein interfaceToggleBuilder- Parameters:
defaultValue- true for active, false for inactive (default: false)- Returns:
- this builder
-
transformer
public ToggleBuilder transformer(java.util.function.Function<java.lang.String,java.lang.String> transformer)
Description copied from interface:BaseBuilderSet 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:
transformerin interfaceBaseBuilder<ToggleBuilder>- Parameters:
transformer- the transformer function- Returns:
- this builder instance for method chaining
-
filter
public ToggleBuilder filter(java.util.function.Function<java.lang.String,java.lang.String> filter)
Description copied from interface:BaseBuilderSet 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:
filterin interfaceBaseBuilder<ToggleBuilder>- Parameters:
filter- the filter function- Returns:
- this builder instance for method chaining
-
addPrompt
public PromptBuilder addPrompt()
Description copied from interface:BaseBuilderComplete the configuration of this prompt and add it to the parent builder.This method finalizes the current prompt configuration, validates that all required fields are set, creates the prompt instance, and adds it to the parent
PromptBuilder. After calling this method, you can continue adding more prompts or callPromptBuilder.build()to create the final list.Validation:
This method typically validates that:
- The prompt name is set and unique
- The message is set and non-empty
- Any prompt-specific requirements are met (e.g., list items are added)
Example Usage:
PromptBuilder builder = prompter.newBuilder(); builder.createListPrompt() .name("color") .message("Choose a color:") .newItem("red").text("Red").add() .newItem("blue").text("Blue").add() .addPrompt() // Completes this prompt and returns to builder .createConfirmPrompt() .name("confirm") .message("Are you sure?") .addPrompt(); // Completes second prompt List<Prompt> prompts = builder.build();- Specified by:
addPromptin interfaceBaseBuilder<ToggleBuilder>- Returns:
- the parent
PromptBuilderfor continued prompt configuration - See Also:
PromptBuilder.build()
-
-