Package org.jline.consoleui.prompt

Class ConsolePrompt

java.lang.Object

org.jline.consoleui.prompt.ConsolePrompt

public class ConsolePrompt
extends Object

ConsolePrompt encapsulates the prompting of a list of input questions for the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConsolePrompt.UiConfig	ConsoleUI configuration: colors, cursor pointer and selected/unselected/unavailable boxes.

Constructor Summary

Constructors

Constructor	Description
ConsolePrompt(org.jline.reader.LineReader reader, org.jline.terminal.Terminal terminal, ConsolePrompt.UiConfig config)
ConsolePrompt(org.jline.terminal.Terminal terminal)
ConsolePrompt(org.jline.terminal.Terminal terminal, ConsolePrompt.UiConfig config)

Method Summary

Modifier and Type	Method	Description
PromptBuilder	getPromptBuilder()	Creates a PromptBuilder.
Map<String,PromptResultItemIF>	prompt(List<PromptableElementIF> promptableElementList)	Prompt a list of choices (questions).
Map<String,PromptResultItemIF>	prompt(List<org.jline.utils.AttributedString> header, List<PromptableElementIF> promptableElementList)	Prompt a list of choices (questions).

Methods inherited from class java.lang.Object

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

Constructor Details

ConsolePrompt

public ConsolePrompt(org.jline.terminal.Terminal terminal)

Parameters:

terminal - the terminal.

ConsolePrompt

public ConsolePrompt(org.jline.terminal.Terminal terminal,
 ConsolePrompt.UiConfig config)

Parameters:

terminal - the terminal.

config - ConsolePrompt cursor pointer and checkbox configuration

ConsolePrompt

public ConsolePrompt(org.jline.reader.LineReader reader,
 org.jline.terminal.Terminal terminal,
 ConsolePrompt.UiConfig config)

Parameters:

reader - the lineReader.

terminal - the terminal.

config - ConsolePrompt cursor pointer and checkbox configuration

Method Details

prompt

public Map<String,PromptResultItemIF> prompt(List<PromptableElementIF> promptableElementList)
                                      throws IOException

Prompt a list of choices (questions). This method takes a list of promptable elements, typically created with PromptBuilder. Each of the elements is processed and the user entries and answers are filled in to the result map. The result map contains the key of each promptable element and the user entry as an object implementing PromptResultItemIF.

Parameters:

promptableElementList - the list of questions / prompts to ask the user for.

Returns:

a map containing a result for each element of promptableElementList

Throws:

IOException - may be thrown by terminal

prompt

public Map<String,PromptResultItemIF> prompt(List<org.jline.utils.AttributedString> header,
 List<PromptableElementIF> promptableElementList)
                                      throws IOException

Prompt a list of choices (questions). This method takes a list of promptable elements, typically created with PromptBuilder. Each of the elements is processed and the user entries and answers are filled in to the result map. The result map contains the key of each promptable element and the user entry as an object implementing PromptResultItemIF.

Parameters:

header - info to be displayed before first prompt.

promptableElementList - the list of questions / prompts to ask the user for.

Returns:

a map containing a result for each element of promptableElementList

Throws:

IOException - may be thrown by terminal

getPromptBuilder

public PromptBuilder getPromptBuilder()

Creates a PromptBuilder.

Returns:

a new prompt builder object.