Package org.aesh.readline

Class ReadlineRequest.Builder

java.lang.Object
org.aesh.readline.ReadlineRequest.Builder
Enclosing class:
ReadlineRequest
public static class ReadlineRequest.Builder extends Object
Builder for constructing ReadlineRequest instances. The connection(Connection), prompt(Prompt), and requestHandler(Consumer) fields are required.

  • Method Details

    • connection

      public ReadlineRequest.Builder connection(Connection connection)
      Sets the terminal connection (required).
      Parameters:
      connection - the terminal connection
      Returns:
      this builder

    • prompt

      public ReadlineRequest.Builder prompt(Prompt prompt)
      Sets the prompt to display (required).
      Parameters:
      prompt - the prompt
      Returns:
      this builder

    • prompt

      public ReadlineRequest.Builder prompt(String prompt)
      Sets the prompt to display using a string (required).
      Parameters:
      prompt - the prompt string
      Returns:
      this builder

    • requestHandler

      public ReadlineRequest.Builder requestHandler(Consumer<String> requestHandler)
      Sets the callback to receive the completed input line (required).
      Parameters:
      requestHandler - the request handler
      Returns:
      this builder

    • completions

      public ReadlineRequest.Builder completions(List<Completion> completions)
      Sets the list of completions for tab completion.
      Parameters:
      completions - the completions list
      Returns:
      this builder

    • preProcessors

      public ReadlineRequest.Builder preProcessors(List<Function<String,Optional<String>>> preProcessors)
      Sets the list of input pre-processors.
      Parameters:
      preProcessors - the pre-processors list
      Returns:
      this builder

    • history

      public ReadlineRequest.Builder history(History history)
      Sets the history instance to use for this readline operation.
      Parameters:
      history - the history instance
      Returns:
      this builder

    • cursorListener

      public ReadlineRequest.Builder cursorListener(CursorListener cursorListener)
      Sets the cursor listener to receive cursor movement events.
      Parameters:
      cursorListener - the cursor listener
      Returns:
      this builder

    • flags

      public ReadlineRequest.Builder flags(EnumMap<ReadlineFlag,Integer> flags)
      Sets the readline flags controlling behavior.
      Parameters:
      flags - the flags map
      Returns:
      this builder

    • build

      public ReadlineRequest build()
      Builds a new ReadlineRequest from this builder's configuration.
      Returns:
      a new ReadlineRequest instance
      Throws:
      NullPointerException - if connection, prompt, or requestHandler is null