Interface BaseBuilder<T extends BaseBuilder<T>>

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      PromptBuilder addPrompt()
      Complete the configuration of this prompt and add it to the parent builder.
      default T filter​(java.util.function.Function<java.lang.String,​java.lang.String> filter)
      Set a filter function that modifies the actual returned value.
      T message​(java.lang.String message)
      Set the message displayed to the user for this prompt.
      T name​(java.lang.String name)
      Set the unique identifier for this prompt.
      default T transformer​(java.util.function.Function<java.lang.String,​java.lang.String> transformer)
      Set a transformer function that modifies how the answer is displayed after submission.
    • Method Detail

      • transformer

        default T transformer​(java.util.function.Function<java.lang.String,​java.lang.String> transformer)
        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 "***".
        Parameters:
        transformer - the transformer function
        Returns:
        this builder instance for method chaining
      • filter

        default T filter​(java.util.function.Function<java.lang.String,​java.lang.String> filter)
        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.
        Parameters:
        filter - the filter function
        Returns:
        this builder instance for method chaining
      • name

        T name​(java.lang.String name)
        Set 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");
         
        Parameters:
        name - the unique identifier for this prompt (required, non-null, non-empty)
        Returns:
        this builder instance for method chaining
        Throws:
        java.lang.IllegalArgumentException - if name is null or empty
      • message

        T message​(java.lang.String message)
        Set 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:"
        Parameters:
        message - the message to display to the user (required, non-null, non-empty)
        Returns:
        this builder instance for method chaining
        Throws:
        java.lang.IllegalArgumentException - if message is null or empty
      • addPrompt

        PromptBuilder addPrompt()
        Complete 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 call PromptBuilder.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();
         
        Returns:
        the parent PromptBuilder for continued prompt configuration
        Throws:
        java.lang.IllegalStateException - if required fields are not set or validation fails
        See Also:
        PromptBuilder.build()