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

Class DefaultTextBuilder

java.lang.Object
org.jline.prompt.impl.DefaultTextBuilder
All Implemented Interfaces:
BaseBuilder<TextBuilder>, TextBuilder
public class DefaultTextBuilder extends Object implements TextBuilder
Default implementation of TextBuilder. This is now the native implementation that doesn't depend on console-ui.

  • Constructor Details

    • DefaultTextBuilder

      public DefaultTextBuilder(PromptBuilder parent)
      Create a new DefaultTextBuilder with the given parent.
      Parameters:
      parent - the parent builder

  • Method Details

    • name

      public TextBuilder name(String name)
      Set the name of this text.
      Specified by:
      name in interface BaseBuilder<TextBuilder>
      Parameters:
      name - the name
      Returns:
      this builder

    • text

      public TextBuilder text(String text)
      Set the text to display.
      Specified by:
      text in interface TextBuilder
      Parameters:
      text - the text
      Returns:
      this builder

    • message

      public TextBuilder message(String message)
      Set the message for this text display.
      Specified by:
      message in interface BaseBuilder<TextBuilder>
      Parameters:
      message - the message
      Returns:
      this builder

    • transformer

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

    • filter

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

    • addPrompt

      public PromptBuilder addPrompt()
      Add this text to the parent builder.
      Specified by:
      addPrompt in interface BaseBuilder<TextBuilder>
      Returns:
      the parent PromptBuilder for continued prompt configuration
      See Also: