Module org.jline.prompt
Package org.jline.prompt.impl

Class DefaultKeyPressBuilder

java.lang.Object
org.jline.prompt.impl.DefaultKeyPressBuilder
All Implemented Interfaces:
BaseBuilder<KeyPressBuilder>, KeyPressBuilder
public class DefaultKeyPressBuilder extends Object implements KeyPressBuilder
Default implementation of KeyPressBuilder.

  • Constructor Details

    • DefaultKeyPressBuilder

      public DefaultKeyPressBuilder(PromptBuilder parent)

  • Method Details

    • name

      public KeyPressBuilder name(String name)
      Description copied from interface: BaseBuilder
      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");
      Specified by:
      name in interface BaseBuilder<KeyPressBuilder>
      Parameters:
      name - the unique identifier for this prompt (required, non-null, non-empty)
      Returns:
      this builder instance for method chaining

    • message

      public KeyPressBuilder message(String message)
      Description copied from interface: BaseBuilder
      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:"
      Specified by:
      message in interface BaseBuilder<KeyPressBuilder>
      Parameters:
      message - the message to display to the user (required, non-null, non-empty)
      Returns:
      this builder instance for method chaining

    • hint

      public KeyPressBuilder hint(String hint)
      Description copied from interface: KeyPressBuilder
      Set the hint text displayed to the user.
      Specified by:
      hint in interface KeyPressBuilder
      Parameters:
      hint - the hint text (default: "Press any key to continue...")
      Returns:
      this builder

    • transformer

      public KeyPressBuilder 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<KeyPressBuilder>
      Parameters:
      transformer - the transformer function
      Returns:
      this builder instance for method chaining

    • filter

      public KeyPressBuilder 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<KeyPressBuilder>
      Parameters:
      filter - the filter function
      Returns:
      this builder instance for method chaining

    • addPrompt

      public PromptBuilder addPrompt()
      Description copied from interface: BaseBuilder
      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();
      Specified by:
      addPrompt in interface BaseBuilder<KeyPressBuilder>
      Returns:
      the parent PromptBuilder for continued prompt configuration
      See Also: