Interface InputProcessor

public interface InputProcessor
InputProcessor is used by Readline to process the input. InputProcessor is using an instance of ConsoleBuffer to do provide easy access to writing/reading from the stream, and access to history/undo/etc.

It is also used by many of the different action classes that react to specific user input.

Author:
Ståle W. Pedersen
API Note:
This interface is an internal implementation detail of the readline library and is not intended for use by external consumers. It may change without notice in future releases.

  • Method Details

    • returnValue

      String returnValue()
      The value thats returned after a readline
      Returns:
      value

    • buffer

      ConsoleBuffer buffer()
      Gets the current console buffer.
      Returns:
      current console buffer

    • setReturnValue

      void setReturnValue(int[] value)
      Specify the return value.
      Parameters:
      value - return value

    • setReturnValue

      default void setReturnValue(String value)
      Set the return value as a String.
      Parameters:
      value - the return value

    • editMode

      EditMode editMode()
      Gets the current edit mode.
      Returns:
      the current edit mode

    • setEditMode

      void setEditMode(EditMode mode)
      Update the current edit mode.
      Parameters:
      mode - edit mode

    • connection

      org.aesh.terminal.Connection connection()
      Gets the connection.
      Returns:
      the Connection

    • finish

      void finish(String out)
      Finishes the input processing with the given output.
      Parameters:
      out - the output string

    • flags

      EnumMap<ReadlineFlag, Integer> flags()
      Gets the current readline flags.
      Returns:
      current flags