Class DefaultInputBuilder

  • All Implemented Interfaces:
    BaseBuilder<InputBuilder>, InputBuilder

    public class DefaultInputBuilder
    extends java.lang.Object
    implements InputBuilder
    Default implementation of InputBuilder. This is now the native implementation that doesn't depend on console-ui.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PromptBuilder addPrompt()
      Add this prompt to the parent builder and return to the parent.
      InputBuilder completer​(org.jline.reader.Completer completer)
      Set the completer to use.
      InputBuilder defaultValue​(java.lang.String defaultValue)
      Set the default value.
      InputBuilder filter​(java.util.function.Function<java.lang.String,​java.lang.String> filter)
      Set the filter function.
      InputBuilder lineReader​(org.jline.reader.LineReader lineReader)
      Set the line reader to use.
      InputBuilder mask​(java.lang.Character mask)
      Set the mask character for the input.
      InputBuilder message​(java.lang.String message)
      Set the message to display to the user.
      InputBuilder name​(java.lang.String name)
      Set the name of this prompt.
      InputBuilder transformer​(java.util.function.Function<java.lang.String,​java.lang.String> transformer)
      Set the transformer function.
      InputBuilder validator​(java.util.function.Function<java.lang.String,​java.lang.Boolean> validator)
      Set the validator to use.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DefaultInputBuilder

        public DefaultInputBuilder​(PromptBuilder parent)
        Create a new DefaultInputBuilder with the given parent.
        Parameters:
        parent - the parent builder
    • Method Detail

      • name

        public InputBuilder name​(java.lang.String name)
        Set the name of this prompt.
        Specified by:
        name in interface BaseBuilder<InputBuilder>
        Parameters:
        name - the name
        Returns:
        this builder
      • message

        public InputBuilder message​(java.lang.String message)
        Set the message to display to the user.
        Specified by:
        message in interface BaseBuilder<InputBuilder>
        Parameters:
        message - the message
        Returns:
        this builder
      • defaultValue

        public InputBuilder defaultValue​(java.lang.String defaultValue)
        Set the default value.
        Specified by:
        defaultValue in interface InputBuilder
        Parameters:
        defaultValue - the default value
        Returns:
        this builder
      • mask

        public InputBuilder mask​(java.lang.Character mask)
        Set the mask character for the input.
        Specified by:
        mask in interface InputBuilder
        Parameters:
        mask - the mask character, or null to disable masking
        Returns:
        this builder
      • completer

        public InputBuilder completer​(org.jline.reader.Completer completer)
        Set the completer to use.
        Specified by:
        completer in interface InputBuilder
        Parameters:
        completer - the completer
        Returns:
        this builder
        See Also:
        org.jline.reader.impl.completer.FileNameCompleter, StringsCompleter
      • lineReader

        public InputBuilder lineReader​(org.jline.reader.LineReader lineReader)
        Set the line reader to use.
        Specified by:
        lineReader in interface InputBuilder
        Parameters:
        lineReader - the line reader
        Returns:
        this builder
        See Also:
        LineReaderBuilder
      • validator

        public InputBuilder validator​(java.util.function.Function<java.lang.String,​java.lang.Boolean> validator)
        Set the validator to use.
        Specified by:
        validator in interface InputBuilder
        Parameters:
        validator - the validator
        Returns:
        this builder
      • transformer

        public InputBuilder transformer​(java.util.function.Function<java.lang.String,​java.lang.String> transformer)
        Set the transformer function.
        Specified by:
        transformer in interface BaseBuilder<InputBuilder>
        Parameters:
        transformer - the transformer
        Returns:
        this builder
      • filter

        public InputBuilder filter​(java.util.function.Function<java.lang.String,​java.lang.String> filter)
        Set the filter function.
        Specified by:
        filter in interface BaseBuilder<InputBuilder>
        Parameters:
        filter - the filter
        Returns:
        this builder