Package org.aesh.readline
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
-
Method Summary
Modifier and TypeMethodDescriptionbuffer()Gets the current console buffer.Gets the connection.editMode()Gets the current edit mode.voidFinishes the input processing with the given output.flags()Gets the current readline flags.The value thats returned after a readlinevoidsetEditMode(EditMode mode) Update the current edit mode.voidsetReturnValue(int[] value) Specify the return value.
-
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
-
editMode
EditMode editMode()Gets the current edit mode.- Returns:
- the current edit mode
-
setEditMode
Update the current edit mode.- Parameters:
mode- edit mode
-
connection
Connection connection()Gets the connection.- Returns:
- the Connection
-
finish
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
-