Package org.aesh.readline

Class ReadlineRequest

java.lang.Object

org.aesh.readline.ReadlineRequest

public class ReadlineRequest
extends Object

Encapsulates all parameters for a Readline.readline(ReadlineRequest) call. Use the builder() method to create instances via the builder pattern.

Example usage:

 ReadlineRequest request = ReadlineRequest.builder()
         .connection(conn)
         .prompt(new Prompt("$ "))
         .requestHandler(line -> System.out.println("Got: " + line))
         .completions(myCompletions)
         .build();
 readline.readline(request);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadlineRequest.Builder	Builder for constructing ReadlineRequest instances.

Method Summary

Modifier and Type	Method	Description
static ReadlineRequest.Builder	builder()	Creates a new builder for constructing a ReadlineRequest.
List<Completion>	completions()	Returns the list of completions for tab completion, or null if not set.
Connection	connection()	Returns the terminal connection.
CursorListener	cursorListener()	Returns the cursor listener, or null if not set.
EnumMap<ReadlineFlag,Integer>	flags()	Returns the readline flags controlling behavior.
History	history()	Returns the history instance to use, or null to use the default.
List<Function<String,Optional<String>>>	preProcessors()	Returns the list of input pre-processors, or null if not set.
Prompt	prompt()	Returns the prompt to display.
Consumer<String>	requestHandler()	Returns the callback to receive the completed input line.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static ReadlineRequest.Builder builder()

Creates a new builder for constructing a ReadlineRequest.

Returns:

a new builder instance

connection

public Connection connection()

Returns the terminal connection.

Returns:

the connection, never null

prompt

public Prompt prompt()

Returns the prompt to display.

Returns:

the prompt, never null

requestHandler

public Consumer<String> requestHandler()

Returns the callback to receive the completed input line.

Returns:

the request handler, never null

completions

public List<Completion> completions()

Returns the list of completions for tab completion, or null if not set.

Returns:

the completions list, or null

preProcessors

public List<Function<String,Optional<String>>> preProcessors()

Returns the list of input pre-processors, or null if not set.

Returns:

the pre-processors list, or null

history

public History history()

Returns the history instance to use, or null to use the default.

Returns:

the history instance, or null

cursorListener

public CursorListener cursorListener()

Returns the cursor listener, or null if not set.

Returns:

the cursor listener, or null

flags

public EnumMap<ReadlineFlag,Integer> flags()

Returns the readline flags controlling behavior.

Returns:

the flags map, never null