Index

A B C D E F G H I K L M N O P R S T U V W Y 
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractPromptResult<T> - Class in org.jline.prompt.impl
Abstract base class for prompt results.
AbstractPromptResult(T) - Constructor for class org.jline.prompt.impl.AbstractPromptResult
Create a new AbstractPromptResult with the given prompt.
activeLabel(String) - Method in class org.jline.prompt.impl.DefaultToggleBuilder
 
activeLabel(String) - Method in interface org.jline.prompt.ToggleBuilder
Set the label for the active (on) state.
add() - Method in interface org.jline.prompt.CheckboxBuilder
Add the current item to the list.
add() - Method in interface org.jline.prompt.CheckboxSeparatorBuilder
Add the separator to the checkbox prompt and return to the checkbox builder.
add() - Method in interface org.jline.prompt.ChoiceBuilder
Add the current choice to the list.
add() - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Add the current item to the list.
add() - Method in class org.jline.prompt.impl.DefaultCheckboxSeparatorBuilder
 
add() - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Add the current choice to the list.
add() - Method in class org.jline.prompt.impl.DefaultListBuilder
Add the current item to the list.
add() - Method in class org.jline.prompt.impl.DefaultListSeparatorBuilder
 
add() - Method in interface org.jline.prompt.ListBuilder
Add the current item to the list.
add() - Method in interface org.jline.prompt.ListSeparatorBuilder
Add the separator to the list prompt and return to the list builder.
add(String, String) - Method in interface org.jline.prompt.CheckboxBuilder
Convenience method to add a simple checkbox item with name and text.
add(String, String) - Method in interface org.jline.prompt.ListBuilder
Convenience method to add a simple list item with name and text.
add(String, String, boolean) - Method in interface org.jline.prompt.CheckboxBuilder
Convenience method to add a simple checkbox item with name, text, and checked state.
add(String, String, boolean) - Method in interface org.jline.prompt.ListBuilder
Convenience method to add a simple list item with name, text, and disabled state.
add(String, String, boolean, boolean) - Method in interface org.jline.prompt.CheckboxBuilder
Convenience method to add a checkbox item with all options.
add(String, String, boolean, String) - Method in interface org.jline.prompt.ListBuilder
Convenience method to add a simple list item with name, text, disabled state, and disabled text.
add(String, String, char) - Method in interface org.jline.prompt.ChoiceBuilder
Convenience method to add a simple choice item with name, text, and key.
add(String, String, char, boolean) - Method in interface org.jline.prompt.ChoiceBuilder
Convenience method to add a choice item with name, text, key, and default state.
add(String, String, char, String, boolean) - Method in interface org.jline.prompt.ChoiceBuilder
Convenience method to add a choice item with all options.
addPrompt() - Method in interface org.jline.prompt.BaseBuilder
Complete the configuration of this prompt and add it to the parent builder.
addPrompt() - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Add this prompt to the parent builder.
addPrompt() - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Add this prompt to the parent builder.
addPrompt() - Method in class org.jline.prompt.impl.DefaultConfirmBuilder
Add this prompt to the parent builder.
addPrompt() - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
addPrompt() - Method in class org.jline.prompt.impl.DefaultInputBuilder
Add this prompt to the parent builder and return to the parent.
addPrompt() - Method in class org.jline.prompt.impl.DefaultKeyPressBuilder
 
addPrompt() - Method in class org.jline.prompt.impl.DefaultListBuilder
Add this prompt to the parent builder and return to the parent.
addPrompt() - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
addPrompt() - Method in class org.jline.prompt.impl.DefaultPasswordBuilder
 
addPrompt() - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
addPrompt() - Method in class org.jline.prompt.impl.DefaultTextBuilder
Add this text to the parent builder.
addPrompt() - Method in class org.jline.prompt.impl.DefaultToggleBuilder
 
addPrompt(Prompt) - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
addPrompt(Prompt) - Method in interface org.jline.prompt.PromptBuilder
Add a prompt to the builder.
addSeparator(SeparatorItem) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Add a separator item to the list.
addSeparator(SeparatorItem) - Method in class org.jline.prompt.impl.DefaultListBuilder
Add a separator item to the list.
Advanced Usage - Search tag in package org.jline.prompt
Section
allowDecimals() - Method in class org.jline.prompt.impl.DefaultNumberPrompt
 
allowDecimals() - Method in interface org.jline.prompt.NumberPrompt
Whether to allow decimal numbers or only integers.
allowDecimals(boolean) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
allowDecimals(boolean) - Method in interface org.jline.prompt.NumberBuilder
Set whether to allow decimal numbers.
allResultsExist(Map<String, ? extends PromptResult<? extends Prompt>>, String...) - Static method in class org.jline.prompt.DynamicPromptHelper
Checks if all specified results exist.
AN - Static variable in interface org.jline.prompt.PrompterConfig
Answer text style
anyResultExists(Map<String, ? extends PromptResult<? extends Prompt>>, String...) - Static method in class org.jline.prompt.DynamicPromptHelper
Checks if any of the specified results exist.
applyFilter(String) - Method in class org.jline.prompt.impl.AbstractPromptResult
Apply a filter to this result.
Architecture - Search tag in package org.jline.prompt
Section

B

BaseBuilder<T> - Interface in org.jline.prompt
Base interface for all prompt builders providing common configuration methods.
Basic Usage - Search tag in interface org.jline.prompt.InputBuilder
Section
Basic Usage - Search tag in interface org.jline.prompt.Prompter
Section
Basic Usage - Search tag in package org.jline.prompt
Section
BD - Static variable in interface org.jline.prompt.PrompterConfig
Box disabled style
BE - Static variable in interface org.jline.prompt.PrompterConfig
Box enabled style
build() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
build() - Method in interface org.jline.prompt.PromptBuilder
Build the list of prompts.
Built-in Completers: - Search tag in org.jline.prompt.InputBuilder.completer(Completer)
Section

C

cancellableFirstPrompt() - Method in class org.jline.prompt.impl.DefaultPrompterConfig
 
cancellableFirstPrompt() - Method in interface org.jline.prompt.PrompterConfig
Whether the first prompt can be cancelled.
CB - Static variable in interface org.jline.prompt.PrompterConfig
Checkbox style
chain(Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>...) - Static method in class org.jline.prompt.DynamicPromptHelper
Creates a prompt provider that chains multiple conditional providers.
CheckboxBuilder - Interface in org.jline.prompt
Builder for checkbox prompts.
CheckboxItem - Interface in org.jline.prompt
Interface for checkbox items in the Prompter.
CheckboxPrompt - Interface in org.jline.prompt
Interface for checkbox prompts.
CheckboxResult - Interface in org.jline.prompt
Result of a checkbox choice.
CheckboxSeparatorBuilder - Interface in org.jline.prompt
Builder interface for checkbox separators.
checked(boolean) - Method in interface org.jline.prompt.CheckboxBuilder
Set whether the current item is checked.
checked(boolean) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Set whether the current item is checked.
checkedBox() - Method in class org.jline.prompt.impl.DefaultPrompterConfig
 
checkedBox() - Method in interface org.jline.prompt.PrompterConfig
Get the checked box character/string.
ChoiceBuilder - Interface in org.jline.prompt
Builder for choice prompts.
ChoiceItem - Interface in org.jline.prompt
Interface for choice items in the Prompter.
ChoicePrompt - Interface in org.jline.prompt
Interface for choice prompts.
ChoiceResult - Interface in org.jline.prompt
Result of an expandable choice prompt.
Common Mask Characters: - Search tag in org.jline.prompt.InputBuilder.mask(Character)
Section
Common Usage Pattern - Search tag in interface org.jline.prompt.BaseBuilder
Section
completer(Completer) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the completer to use.
completer(Completer) - Method in interface org.jline.prompt.InputBuilder
Set the completer to provide auto-completion suggestions.
ConfirmBuilder - Interface in org.jline.prompt
Builder for confirmation prompts.
ConfirmItem - Interface in org.jline.prompt
Interface for confirmation items in the Prompter.
ConfirmPrompt - Interface in org.jline.prompt
Interface for confirmation prompts.
ConfirmResult - Interface in org.jline.prompt
Result of a confirmation prompt.
ConfirmResult.ConfirmationValue - Enum Class in org.jline.prompt
Possible confirmation values.
Context(InputStream, PrintStream, PrintStream, Path, Terminal, Function<String, Object>) - Constructor for class org.jline.prompt.PromptCommands.Context
 
create(LineReader, Terminal, PrompterConfig) - Static method in class org.jline.prompt.PrompterFactory
Create a new Prompter instance with the given line reader, terminal, and configuration.
create(Terminal) - Static method in class org.jline.prompt.PrompterFactory
Create a new Prompter instance with the given terminal.
create(Terminal, PrompterConfig) - Static method in class org.jline.prompt.PrompterFactory
Create a new Prompter instance with the given terminal and configuration.
createCheckboxPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createCheckboxPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for checkbox prompts.
createChoicePrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createChoicePrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for choice prompts.
createConfirmPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createConfirmPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for confirmation prompts.
createEditorPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createEditorPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for editor prompts.
createInputPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createInputPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for input prompts.
createKeyPressPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createKeyPressPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for key press prompts.
createListPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createListPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for list prompts.
createNumberPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createNumberPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for number prompts.
createPasswordPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createPasswordPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for password prompts.
createSearchPrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createSearchPrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for search prompts.
createText() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createText() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for text displays.
createTogglePrompt() - Method in class org.jline.prompt.impl.DefaultPromptBuilder
 
createTogglePrompt() - Method in interface org.jline.prompt.PromptBuilder
Create a builder for toggle prompts.
currentDir() - Method in class org.jline.prompt.PromptCommands.Context
 
CURSOR - Static variable in interface org.jline.prompt.PrompterConfig
Cursor/selection indicator style
custom(String, String, String, String) - Static method in class org.jline.prompt.impl.DefaultPrompterConfig
Create a configuration with default styling support.
custom(String, String, String, String, StyleResolver, boolean) - Static method in class org.jline.prompt.impl.DefaultPrompterConfig
 
custom(String, String, String, String, StyleResolver, boolean) - Static method in interface org.jline.prompt.PrompterConfig
Create a custom configuration with style resolver support.
custom(StyleResolver) - Static method in class org.jline.prompt.impl.DefaultPrompterConfig
 
Custom Configuration - Search tag in package org.jline.prompt
Section

D

DEFAULT_TIMEOUT_WITH_ESC - Static variable in class org.jline.prompt.impl.DefaultPrompter
 
DefaultCheckboxBuilder - Class in org.jline.prompt.impl
Default implementation of CheckboxBuilder.
DefaultCheckboxBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultCheckboxBuilder
Create a new DefaultCheckboxBuilder with the given parent.
DefaultCheckboxItem - Class in org.jline.prompt.impl
Default implementation of CheckboxItem interface.
DefaultCheckboxItem(String, String) - Constructor for class org.jline.prompt.impl.DefaultCheckboxItem
 
DefaultCheckboxItem(String, String, boolean) - Constructor for class org.jline.prompt.impl.DefaultCheckboxItem
 
DefaultCheckboxItem(String, String, boolean, boolean, String) - Constructor for class org.jline.prompt.impl.DefaultCheckboxItem
 
DefaultCheckboxItem(String, String, boolean, boolean, String, String) - Constructor for class org.jline.prompt.impl.DefaultCheckboxItem
 
DefaultCheckboxPrompt - Class in org.jline.prompt.impl
Default implementation of CheckboxPrompt interface.
DefaultCheckboxPrompt(String, String, List<CheckboxItem>) - Constructor for class org.jline.prompt.impl.DefaultCheckboxPrompt
 
DefaultCheckboxPrompt(String, String, List<CheckboxItem>, int) - Constructor for class org.jline.prompt.impl.DefaultCheckboxPrompt
 
DefaultCheckboxPrompt(String, String, List<CheckboxItem>, int, boolean) - Constructor for class org.jline.prompt.impl.DefaultCheckboxPrompt
 
DefaultCheckboxPrompt(String, String, List<CheckboxItem>, int, boolean, int, int) - Constructor for class org.jline.prompt.impl.DefaultCheckboxPrompt
 
DefaultCheckboxPrompt(String, String, List<CheckboxItem>, int, boolean, int, int, boolean) - Constructor for class org.jline.prompt.impl.DefaultCheckboxPrompt
 
DefaultCheckboxResult - Class in org.jline.prompt.impl
Implementation of CheckboxResult.
DefaultCheckboxResult(Set<String>, CheckboxPrompt) - Constructor for class org.jline.prompt.impl.DefaultCheckboxResult
Create a new DefaultCheckboxResult with the given selected IDs and item.
DefaultCheckboxSeparatorBuilder - Class in org.jline.prompt.impl
Default implementation of CheckboxSeparatorBuilder.
DefaultCheckboxSeparatorBuilder(DefaultCheckboxBuilder) - Constructor for class org.jline.prompt.impl.DefaultCheckboxSeparatorBuilder
 
DefaultCheckboxSeparatorBuilder(DefaultCheckboxBuilder, String) - Constructor for class org.jline.prompt.impl.DefaultCheckboxSeparatorBuilder
 
defaultChoice(boolean) - Method in interface org.jline.prompt.ChoiceBuilder
Set whether the current choice is the default.
defaultChoice(boolean) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Set whether the current choice is the default.
DefaultChoiceBuilder - Class in org.jline.prompt.impl
Default implementation of ChoiceBuilder.
DefaultChoiceBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultChoiceBuilder
Create a new DefaultChoiceBuilder with the given parent.
DefaultChoiceItem - Class in org.jline.prompt.impl
Default implementation of ChoiceItem interface.
DefaultChoiceItem(String, String, char) - Constructor for class org.jline.prompt.impl.DefaultChoiceItem
 
DefaultChoiceItem(String, String, char, String, boolean) - Constructor for class org.jline.prompt.impl.DefaultChoiceItem
 
DefaultChoicePrompt - Class in org.jline.prompt.impl
Default implementation of ChoicePrompt interface.
DefaultChoicePrompt(String, String, List<ChoiceItem>) - Constructor for class org.jline.prompt.impl.DefaultChoicePrompt
 
DefaultChoiceResult - Class in org.jline.prompt.impl
Implementation of ChoiceResult.
DefaultChoiceResult(String, ChoicePrompt) - Constructor for class org.jline.prompt.impl.DefaultChoiceResult
Create a new DefaultChoiceResult with the given selected ID and item.
Default Configurations: - Search tag in interface org.jline.prompt.PrompterConfig
Section
DefaultConfirmBuilder - Class in org.jline.prompt.impl
Default implementation of ConfirmBuilder.
DefaultConfirmBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultConfirmBuilder
Create a new DefaultConfirmBuilder with the given parent.
DefaultConfirmPrompt - Class in org.jline.prompt.impl
Default implementation of ConfirmPrompt interface.
DefaultConfirmPrompt(String, String, boolean) - Constructor for class org.jline.prompt.impl.DefaultConfirmPrompt
 
DefaultConfirmResult - Class in org.jline.prompt.impl
Implementation of ConfirmResult.
DefaultConfirmResult(ConfirmResult.ConfirmationValue, ConfirmPrompt) - Constructor for class org.jline.prompt.impl.DefaultConfirmResult
Create a new DefaultConfirmResult with the given confirmation value and item.
DefaultEditorBuilder - Class in org.jline.prompt.impl
Default implementation of EditorBuilder.
DefaultEditorBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultEditorBuilder
 
DefaultEditorPrompt - Class in org.jline.prompt.impl
Default implementation of EditorPrompt interface.
DefaultEditorPrompt(String, String) - Constructor for class org.jline.prompt.impl.DefaultEditorPrompt
 
DefaultEditorPrompt(String, String, String) - Constructor for class org.jline.prompt.impl.DefaultEditorPrompt
 
DefaultEditorPrompt(String, String, String, String, String, boolean, boolean) - Constructor for class org.jline.prompt.impl.DefaultEditorPrompt
 
DefaultEditorResult - Class in org.jline.prompt.impl
Implementation of EditorResult.
DefaultEditorResult(String, EditorPrompt) - Constructor for class org.jline.prompt.impl.DefaultEditorResult
Create a new DefaultEditorResult with the given text.
DefaultInputBuilder - Class in org.jline.prompt.impl
Default implementation of InputBuilder.
DefaultInputBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultInputBuilder
Create a new DefaultInputBuilder with the given parent.
DefaultInputPrompt - Class in org.jline.prompt.impl
Default implementation of InputPrompt interface.
DefaultInputPrompt(String, String, String, Character, Completer, LineReader, Function<String, Boolean>) - Constructor for class org.jline.prompt.impl.DefaultInputPrompt
 
DefaultInputResult - Class in org.jline.prompt.impl
Implementation of InputResult.
DefaultInputResult(String, String, InputPrompt) - Constructor for class org.jline.prompt.impl.DefaultInputResult
Create a new DefaultInputResult with the given input, display input, and item.
DefaultKeyPressBuilder - Class in org.jline.prompt.impl
Default implementation of KeyPressBuilder.
DefaultKeyPressBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultKeyPressBuilder
 
DefaultKeyPressPrompt - Class in org.jline.prompt.impl
Default implementation of KeyPressPrompt.
DefaultKeyPressPrompt(String, String, String) - Constructor for class org.jline.prompt.impl.DefaultKeyPressPrompt
 
DefaultKeyPressResult - Class in org.jline.prompt.impl
Implementation of KeyPressResult.
DefaultKeyPressResult(String, KeyPressPrompt) - Constructor for class org.jline.prompt.impl.DefaultKeyPressResult
 
DefaultListBuilder - Class in org.jline.prompt.impl
Default implementation of ListBuilder.
DefaultListBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultListBuilder
Create a new DefaultListBuilder with the given parent.
DefaultListItem - Class in org.jline.prompt.impl
Default implementation of ListItem interface.
DefaultListItem(String, String) - Constructor for class org.jline.prompt.impl.DefaultListItem
 
DefaultListItem(String, String, boolean, String) - Constructor for class org.jline.prompt.impl.DefaultListItem
 
DefaultListItem(String, String, boolean, String, String) - Constructor for class org.jline.prompt.impl.DefaultListItem
 
DefaultListPrompt - Class in org.jline.prompt.impl
Default implementation of ListPrompt interface.
DefaultListPrompt(String, String, List<ListItem>) - Constructor for class org.jline.prompt.impl.DefaultListPrompt
 
DefaultListPrompt(String, String, List<ListItem>, int) - Constructor for class org.jline.prompt.impl.DefaultListPrompt
 
DefaultListPrompt(String, String, List<ListItem>, int, boolean) - Constructor for class org.jline.prompt.impl.DefaultListPrompt
 
DefaultListPrompt(String, String, List<ListItem>, int, boolean, boolean) - Constructor for class org.jline.prompt.impl.DefaultListPrompt
 
DefaultListResult - Class in org.jline.prompt.impl
Implementation of ListResult.
DefaultListResult(String, ListPrompt) - Constructor for class org.jline.prompt.impl.DefaultListResult
Create a new DefaultListResult with the given selected ID and prompt.
DefaultListSeparatorBuilder - Class in org.jline.prompt.impl
Default implementation of ListSeparatorBuilder.
DefaultListSeparatorBuilder(DefaultListBuilder) - Constructor for class org.jline.prompt.impl.DefaultListSeparatorBuilder
 
DefaultListSeparatorBuilder(DefaultListBuilder, String) - Constructor for class org.jline.prompt.impl.DefaultListSeparatorBuilder
 
DefaultNoResult - Class in org.jline.prompt.impl
Implementation of NoResult.
DefaultNumberBuilder - Class in org.jline.prompt.impl
Default implementation of NumberBuilder.
DefaultNumberBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultNumberBuilder
 
DefaultNumberPrompt - Class in org.jline.prompt.impl
Default implementation of NumberPrompt interface.
DefaultNumberPrompt(String, String) - Constructor for class org.jline.prompt.impl.DefaultNumberPrompt
 
DefaultNumberPrompt(String, String, Double, Double) - Constructor for class org.jline.prompt.impl.DefaultNumberPrompt
 
DefaultNumberPrompt(String, String, Double, Double, boolean) - Constructor for class org.jline.prompt.impl.DefaultNumberPrompt
 
DefaultNumberPrompt(String, String, Double, Double, boolean, String, String, String) - Constructor for class org.jline.prompt.impl.DefaultNumberPrompt
 
DefaultPasswordBuilder - Class in org.jline.prompt.impl
Default implementation of PasswordBuilder.
DefaultPasswordBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultPasswordBuilder
 
DefaultPasswordPrompt - Class in org.jline.prompt.impl
Default implementation of PasswordPrompt interface.
DefaultPasswordPrompt(String, String) - Constructor for class org.jline.prompt.impl.DefaultPasswordPrompt
 
DefaultPasswordPrompt(String, String, Character) - Constructor for class org.jline.prompt.impl.DefaultPasswordPrompt
 
DefaultPasswordPrompt(String, String, Character, boolean) - Constructor for class org.jline.prompt.impl.DefaultPasswordPrompt
 
DefaultPasswordPrompt(String, String, String, Character, boolean) - Constructor for class org.jline.prompt.impl.DefaultPasswordPrompt
 
DefaultPrompt - Class in org.jline.prompt.impl
Base implementation class for all prompt types.
DefaultPrompt(String, String) - Constructor for class org.jline.prompt.impl.DefaultPrompt
 
DefaultPromptBuilder - Class in org.jline.prompt.impl
Default implementation of the PromptBuilder interface.
DefaultPromptBuilder() - Constructor for class org.jline.prompt.impl.DefaultPromptBuilder
Create a new DefaultPromptBuilder.
DefaultPrompter - Class in org.jline.prompt.impl
Default implementation of the Prompter interface.
DefaultPrompter(LineReader, Terminal, PrompterConfig) - Constructor for class org.jline.prompt.impl.DefaultPrompter
Create a new DefaultPrompter with the given line reader, terminal, and configuration.
DefaultPrompter(Terminal) - Constructor for class org.jline.prompt.impl.DefaultPrompter
Create a new DefaultPrompter with the given terminal.
DefaultPrompter(Terminal, PrompterConfig) - Constructor for class org.jline.prompt.impl.DefaultPrompter
Create a new DefaultPrompter with the given terminal and configuration.
DefaultPrompterConfig - Class in org.jline.prompt.impl
Default implementation of PrompterConfig interface.
defaults() - Static method in class org.jline.prompt.impl.DefaultPrompterConfig
 
defaults() - Static method in interface org.jline.prompt.PrompterConfig
Create a configuration with platform-specific defaults.
DefaultSearchBuilder<T> - Class in org.jline.prompt.impl
Default implementation of SearchBuilder.
DefaultSearchBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultSearchBuilder
 
DefaultSearchPrompt<T> - Class in org.jline.prompt.impl
Default implementation of SearchPrompt interface.
DefaultSearchPrompt(String, String, Function<String, List<T>>, Function<T, String>, Function<T, String>) - Constructor for class org.jline.prompt.impl.DefaultSearchPrompt
 
DefaultSearchPrompt(String, String, Function<String, List<T>>, Function<T, String>, Function<T, String>, String, int, int) - Constructor for class org.jline.prompt.impl.DefaultSearchPrompt
 
DefaultSearchResult<T> - Class in org.jline.prompt.impl
Implementation of SearchResult.
DefaultSearchResult(String, SearchPrompt<T>) - Constructor for class org.jline.prompt.impl.DefaultSearchResult
Create a new DefaultSearchResult with the given selected value.
DefaultSeparatorItem - Class in org.jline.prompt.impl
Default implementation of SeparatorItem interface.
DefaultSeparatorItem(String) - Constructor for class org.jline.prompt.impl.DefaultSeparatorItem
 
DefaultTextBuilder - Class in org.jline.prompt.impl
Default implementation of TextBuilder.
DefaultTextBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultTextBuilder
Create a new DefaultTextBuilder with the given parent.
DefaultTextPrompt - Class in org.jline.prompt.impl
Default implementation of TextPrompt interface.
DefaultTextPrompt(String, String, String) - Constructor for class org.jline.prompt.impl.DefaultTextPrompt
 
DefaultTextPrompt(String, String, List<AttributedString>) - Constructor for class org.jline.prompt.impl.DefaultTextPrompt
 
DefaultToggleBuilder - Class in org.jline.prompt.impl
Default implementation of ToggleBuilder.
DefaultToggleBuilder(PromptBuilder) - Constructor for class org.jline.prompt.impl.DefaultToggleBuilder
 
DefaultTogglePrompt - Class in org.jline.prompt.impl
Default implementation of TogglePrompt.
DefaultTogglePrompt(String, String, String, String, boolean) - Constructor for class org.jline.prompt.impl.DefaultTogglePrompt
 
DefaultToggleResult - Class in org.jline.prompt.impl
Implementation of ToggleResult.
DefaultToggleResult(boolean, TogglePrompt) - Constructor for class org.jline.prompt.impl.DefaultToggleResult
 
defaultValue(boolean) - Method in interface org.jline.prompt.ConfirmBuilder
Set the default value.
defaultValue(boolean) - Method in class org.jline.prompt.impl.DefaultConfirmBuilder
Set the default value.
defaultValue(boolean) - Method in class org.jline.prompt.impl.DefaultToggleBuilder
 
defaultValue(boolean) - Method in interface org.jline.prompt.ToggleBuilder
Set the default value.
defaultValue(String) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the default value.
defaultValue(String) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
defaultValue(String) - Method in class org.jline.prompt.impl.DefaultPasswordBuilder
 
defaultValue(String) - Method in interface org.jline.prompt.InputBuilder
Set the default value that will be pre-filled in the input field.
defaultValue(String) - Method in interface org.jline.prompt.NumberBuilder
Set the default value.
defaultValue(String) - Method in interface org.jline.prompt.PasswordBuilder
Set the default value.
disabled(boolean) - Method in interface org.jline.prompt.CheckboxBuilder
Set whether the current item is disabled.
disabled(boolean) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Set whether the current item is disabled.
disabled(boolean) - Method in class org.jline.prompt.impl.DefaultListBuilder
Set whether the current item is disabled.
disabled(boolean) - Method in interface org.jline.prompt.ListBuilder
Set whether the current item is disabled.
disabledText(String) - Method in interface org.jline.prompt.CheckboxBuilder
Set the disabled text for the current item.
disabledText(String) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Set the disabled text for the current item.
disabledText(String) - Method in class org.jline.prompt.impl.DefaultListBuilder
Set the disabled text for the current item.
disabledText(String) - Method in interface org.jline.prompt.ListBuilder
Set the disabled text for the current item.
displayFunction(Function<T, String>) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
displayFunction(Function<T, String>) - Method in interface org.jline.prompt.SearchBuilder
Set the display function.
DynamicPromptExample - Class in org.jline.prompt.examples
Example demonstrating dynamic prompting where subsequent prompts depend on previous answers.
DynamicPromptHelper - Class in org.jline.prompt
Utility class to help with dynamic prompting scenarios.
Dynamic Prompts - Search tag in interface org.jline.prompt.Prompter
Section
Dynamic Prompts - Search tag in package org.jline.prompt
Section

E

EditorBuilder - Interface in org.jline.prompt
Builder interface for editor prompts.
EditorPrompt - Interface in org.jline.prompt
Interface for editor prompts.
EditorResult - Interface in org.jline.prompt
Result of an editor prompt.
enableWrapping() - Method in interface org.jline.prompt.EditorPrompt
Whether to enable text wrapping in the editor.
enableWrapping() - Method in class org.jline.prompt.impl.DefaultEditorPrompt
 
enableWrapping(boolean) - Method in interface org.jline.prompt.EditorBuilder
Set whether to enable text wrapping.
enableWrapping(boolean) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
equals(Object) - Method in class org.jline.prompt.impl.DefaultSeparatorItem
 
err() - Method in class org.jline.prompt.PromptCommands.Context
 
ERROR - Static variable in interface org.jline.prompt.PrompterConfig
Error message style
Example: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Example: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Example: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Example: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Example: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Example: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Example: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Example: - Search tag in org.jline.prompt.InputBuilder.completer(Completer)
Section
Example: - Search tag in org.jline.prompt.InputBuilder.defaultValue(String)
Section
Example: - Search tag in org.jline.prompt.InputBuilder.lineReader(LineReader)
Section
Example: - Search tag in org.jline.prompt.InputBuilder.mask(Character)
Section
Example: - Search tag in org.jline.prompt.Prompter.prompt(List<AttributedString>, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>)
Section
Example: - Search tag in org.jline.prompt.Prompter.prompt(List<AttributedString>, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>)
Section
Example: - Search tag in org.jline.prompt.Prompter.prompt(List<AttributedString>, List<? extends Prompt>)
Section
Example: - Search tag in org.jline.prompt.Prompter.prompt(List<AttributedString>, List<? extends Prompt>)
Section
Example Custom Configuration: - Search tag in interface org.jline.prompt.PrompterConfig
Section
Examples: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Examples: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Examples: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Examples: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Examples: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Examples: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Examples: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Examples: - Search tag in org.jline.prompt.PromptResult.getResult()
Section
Example Usage: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Example Usage: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Example Usage: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Example Usage: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Example Usage: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Example Usage: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Example Usage: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Example Usage: - Search tag in org.jline.prompt.PromptResult.getPrompt()
Section
Example Usage: - Search tag in org.jline.prompt.PromptResult.getPrompt()
Section

F

Features - Search tag in interface org.jline.prompt.InputBuilder
Section
fileExtension(String) - Method in interface org.jline.prompt.EditorBuilder
Set the file extension for syntax highlighting.
fileExtension(String) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
filter(Function<String, String>) - Method in interface org.jline.prompt.BaseBuilder
Set a filter function that modifies the actual returned value.
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultConfirmBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the filter function.
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultKeyPressBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultListBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultPasswordBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultTextBuilder
 
filter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultToggleBuilder
 
filterable(boolean) - Method in interface org.jline.prompt.CheckboxBuilder
Set whether the checkbox list supports inline text filtering.
filterable(boolean) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
filterable(boolean) - Method in class org.jline.prompt.impl.DefaultListBuilder
 
filterable(boolean) - Method in interface org.jline.prompt.ListBuilder
Set whether the list supports inline text filtering.
Fluent Interface Pattern - Search tag in interface org.jline.prompt.BaseBuilder
Section
FO - Static variable in interface org.jline.prompt.PrompterConfig
Footer/description text style (dimmed)
footer(String) - Method in interface org.jline.prompt.CheckboxBuilder
Set the footer text for the current item.
footer(String) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
footer(String) - Method in class org.jline.prompt.impl.DefaultListBuilder
 
footer(String) - Method in interface org.jline.prompt.ListBuilder
Set the footer text for the current item.
footerMaxRows() - Method in interface org.jline.prompt.PrompterConfig
Maximum height, in rows, of the dimmed footer pane shown below list and checkbox prompts.

G

getActiveLabel() - Method in class org.jline.prompt.impl.DefaultTogglePrompt
 
getActiveLabel() - Method in interface org.jline.prompt.TogglePrompt
Get the label for the active (on) state.
getCompleter() - Method in class org.jline.prompt.impl.DefaultInputPrompt
 
getCompleter() - Method in class org.jline.prompt.impl.DefaultPasswordPrompt
 
getCompleter() - Method in interface org.jline.prompt.InputPrompt
Get the completer.
getConfirmed() - Method in interface org.jline.prompt.ConfirmResult
Get the confirmation value.
getConfirmed() - Method in class org.jline.prompt.impl.DefaultConfirmResult
 
getDefaultNumber() - Method in interface org.jline.prompt.NumberPrompt
Get the default value as a number.
getDefaultValue() - Method in interface org.jline.prompt.ConfirmItem
Get the default confirmation value.
getDefaultValue() - Method in interface org.jline.prompt.ConfirmPrompt
Get the default value.
getDefaultValue() - Method in class org.jline.prompt.impl.DefaultConfirmPrompt
 
getDefaultValue() - Method in class org.jline.prompt.impl.DefaultInputPrompt
 
getDefaultValue() - Method in class org.jline.prompt.impl.DefaultTogglePrompt
 
getDefaultValue() - Method in interface org.jline.prompt.InputPrompt
Get the default value.
getDefaultValue() - Method in interface org.jline.prompt.TogglePrompt
Get the default value.
getDisabledText() - Method in class org.jline.prompt.impl.DefaultCheckboxItem
 
getDisabledText() - Method in class org.jline.prompt.impl.DefaultListItem
 
getDisabledText() - Method in interface org.jline.prompt.PromptItem
Get the text to display when this item is disabled.
getDisabledText() - Method in interface org.jline.prompt.SeparatorItem
Separators don't have disabled text.
getDisplayFunction() - Method in class org.jline.prompt.impl.DefaultSearchPrompt
 
getDisplayFunction() - Method in interface org.jline.prompt.SearchPrompt
Get the function to convert items to display strings.
getDisplayResult() - Method in class org.jline.prompt.impl.DefaultConfirmResult
 
getDisplayResult() - Method in class org.jline.prompt.impl.DefaultEditorResult
 
getDisplayResult() - Method in class org.jline.prompt.impl.DefaultInputResult
 
getDisplayResult() - Method in class org.jline.prompt.impl.DefaultNoResult
 
getDisplayResult() - Method in class org.jline.prompt.impl.DefaultSearchResult
 
getDisplayResult() - Method in class org.jline.prompt.impl.DefaultToggleResult
 
getDisplayResult() - Method in interface org.jline.prompt.PromptResult
Get a human-readable display representation of the result.
getFileExtension() - Method in interface org.jline.prompt.EditorPrompt
Get the file extension to use for the temporary file.
getFileExtension() - Method in class org.jline.prompt.impl.DefaultEditorPrompt
 
getFilter() - Method in class org.jline.prompt.impl.DefaultPrompt
 
getFilter() - Method in interface org.jline.prompt.Prompt
Get the filter function that modifies the actual returned value.
getFooter() - Method in class org.jline.prompt.impl.DefaultCheckboxItem
 
getFooter() - Method in class org.jline.prompt.impl.DefaultListItem
 
getFooter() - Method in interface org.jline.prompt.PromptItem
Optional footer text shown dimmed below a list or checkbox while this item is focused.
getHelpText() - Method in class org.jline.prompt.impl.DefaultChoiceItem
 
getHint() - Method in class org.jline.prompt.impl.DefaultKeyPressPrompt
 
getHint() - Method in interface org.jline.prompt.KeyPressPrompt
Get the hint text displayed to the user (e.g., "Press any key to continue...").
getInactiveLabel() - Method in class org.jline.prompt.impl.DefaultTogglePrompt
 
getInactiveLabel() - Method in interface org.jline.prompt.TogglePrompt
Get the label for the inactive (off) state.
getInitialText() - Method in interface org.jline.prompt.EditorPrompt
Get the initial text to populate the editor with.
getInitialText() - Method in class org.jline.prompt.impl.DefaultEditorPrompt
 
getInput() - Method in class org.jline.prompt.impl.DefaultInputResult
 
getInput() - Method in interface org.jline.prompt.InputResult
Get the input text.
getInvalidNumberMessage() - Method in class org.jline.prompt.impl.DefaultNumberPrompt
 
getInvalidNumberMessage() - Method in interface org.jline.prompt.NumberPrompt
Get the error message to show for invalid numbers.
getItems() - Method in interface org.jline.prompt.CheckboxPrompt
Get the list of checkbox items.
getItems() - Method in interface org.jline.prompt.ChoicePrompt
Get the list of choice items.
getItems() - Method in class org.jline.prompt.impl.DefaultCheckboxPrompt
 
getItems() - Method in class org.jline.prompt.impl.DefaultChoicePrompt
 
getItems() - Method in class org.jline.prompt.impl.DefaultListPrompt
 
getItems() - Method in interface org.jline.prompt.ListPrompt
Get the list of list items.
getKey() - Method in interface org.jline.prompt.ChoiceItem
Get the key associated with this choice.
getKey() - Method in class org.jline.prompt.impl.DefaultChoiceItem
 
getKey() - Method in class org.jline.prompt.impl.DefaultKeyPressResult
 
getKey() - Method in interface org.jline.prompt.KeyPressResult
Get the key that was pressed.
getLineReader() - Method in class org.jline.prompt.impl.DefaultInputPrompt
 
getLineReader() - Method in class org.jline.prompt.impl.DefaultPrompter
 
getLineReader() - Method in interface org.jline.prompt.InputPrompt
Get the line reader.
getLineReader() - Method in interface org.jline.prompt.Prompter
Get the line reader associated with this Prompter, if any.
getLines() - Method in class org.jline.prompt.impl.DefaultTextPrompt
 
getLines() - Method in interface org.jline.prompt.TextPrompt
Get the text lines as AttributedString list.
getMask() - Method in class org.jline.prompt.impl.DefaultInputPrompt
 
getMask() - Method in class org.jline.prompt.impl.DefaultPasswordPrompt
 
getMask() - Method in interface org.jline.prompt.InputPrompt
Get the mask character for the input.
getMask() - Method in interface org.jline.prompt.PasswordPrompt
Get the mask character to use for hiding input.
getMax() - Method in class org.jline.prompt.impl.DefaultNumberPrompt
 
getMax() - Method in interface org.jline.prompt.NumberPrompt
Get the maximum allowed value.
getMaxResults() - Method in class org.jline.prompt.impl.DefaultSearchPrompt
 
getMaxResults() - Method in interface org.jline.prompt.SearchPrompt
Get the maximum number of results to display.
getMaxSelections() - Method in interface org.jline.prompt.CheckboxPrompt
Get the maximum number of items that can be selected.
getMaxSelections() - Method in class org.jline.prompt.impl.DefaultCheckboxPrompt
 
getMessage() - Method in class org.jline.prompt.impl.DefaultPrompt
 
getMessage() - Method in interface org.jline.prompt.Prompt
Get the message to display to the user.
getMin() - Method in class org.jline.prompt.impl.DefaultNumberPrompt
 
getMin() - Method in interface org.jline.prompt.NumberPrompt
Get the minimum allowed value.
getMinSearchLength() - Method in class org.jline.prompt.impl.DefaultSearchPrompt
 
getMinSearchLength() - Method in interface org.jline.prompt.SearchPrompt
Get the minimum number of characters required before searching.
getMinSelections() - Method in interface org.jline.prompt.CheckboxPrompt
Get the minimum number of items that must be selected.
getMinSelections() - Method in class org.jline.prompt.impl.DefaultCheckboxPrompt
 
getName() - Method in class org.jline.prompt.impl.DefaultCheckboxItem
 
getName() - Method in class org.jline.prompt.impl.DefaultChoiceItem
 
getName() - Method in class org.jline.prompt.impl.DefaultListItem
 
getName() - Method in class org.jline.prompt.impl.DefaultPrompt
 
getName() - Method in interface org.jline.prompt.Prompt
Get the name of this prompt.
getName() - Method in interface org.jline.prompt.PromptItem
Get the name of this item.
getName() - Method in interface org.jline.prompt.SeparatorItem
Separators don't have names for selection.
getOutOfRangeMessage() - Method in class org.jline.prompt.impl.DefaultNumberPrompt
 
getOutOfRangeMessage() - Method in interface org.jline.prompt.NumberPrompt
Get the error message to show for out-of-range numbers.
getPageSize() - Method in interface org.jline.prompt.CheckboxPrompt
Get the page size for pagination.
getPageSize() - Method in class org.jline.prompt.impl.DefaultCheckboxPrompt
 
getPageSize() - Method in class org.jline.prompt.impl.DefaultListPrompt
 
getPageSize() - Method in interface org.jline.prompt.ListPrompt
Get the page size for pagination.
getPlaceholder() - Method in class org.jline.prompt.impl.DefaultSearchPrompt
 
getPlaceholder() - Method in interface org.jline.prompt.SearchPrompt
Get the placeholder text to show when no search term is entered.
getPrompt() - Method in class org.jline.prompt.impl.AbstractPromptResult
 
getPrompt() - Method in interface org.jline.prompt.PromptResult
Get the prompt that generated this result.
getRawResult() - Method in class org.jline.prompt.impl.AbstractPromptResult
Get the raw (unfiltered) result value.
getRawResult() - Method in class org.jline.prompt.impl.DefaultCheckboxResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultChoiceResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultConfirmResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultEditorResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultInputResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultKeyPressResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultListResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultNoResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultSearchResult
 
getRawResult() - Method in class org.jline.prompt.impl.DefaultToggleResult
 
getResult() - Method in class org.jline.prompt.impl.AbstractPromptResult
Returns the filtered result if a filter was applied, otherwise delegates to the subclass implementation via AbstractPromptResult.getRawResult().
getResult() - Method in interface org.jline.prompt.PromptResult
Get the raw result value as a string representation.
getResultValue(Map<String, ? extends PromptResult<? extends Prompt>>, String) - Static method in class org.jline.prompt.DynamicPromptHelper
Gets the result value for a specific prompt, or null if not found.
getSearchFunction() - Method in class org.jline.prompt.impl.DefaultSearchPrompt
 
getSearchFunction() - Method in interface org.jline.prompt.SearchPrompt
Get the search function that filters items based on the search term.
getSelectedId() - Method in interface org.jline.prompt.ChoiceResult
Get the ID of the selected item.
getSelectedId() - Method in class org.jline.prompt.impl.DefaultChoiceResult
 
getSelectedId() - Method in class org.jline.prompt.impl.DefaultListResult
 
getSelectedId() - Method in interface org.jline.prompt.ListResult
Get the ID of the selected item.
getSelectedIds() - Method in interface org.jline.prompt.CheckboxResult
Get the IDs of the selected items.
getSelectedIds() - Method in class org.jline.prompt.impl.DefaultCheckboxResult
 
getSelectedValue() - Method in class org.jline.prompt.impl.DefaultSearchResult
 
getSelectedValue() - Method in interface org.jline.prompt.SearchResult
Get the selected value as a string.
getTerminal() - Method in class org.jline.prompt.impl.DefaultPrompter
 
getTerminal() - Method in interface org.jline.prompt.Prompter
Get the terminal associated with this Prompter.
getText() - Method in interface org.jline.prompt.EditorResult
Get the edited text content.
getText() - Method in class org.jline.prompt.impl.DefaultCheckboxItem
 
getText() - Method in class org.jline.prompt.impl.DefaultChoiceItem
 
getText() - Method in class org.jline.prompt.impl.DefaultEditorResult
 
getText() - Method in class org.jline.prompt.impl.DefaultListItem
 
getText() - Method in class org.jline.prompt.impl.DefaultSeparatorItem
 
getText() - Method in class org.jline.prompt.impl.DefaultTextPrompt
 
getText() - Method in interface org.jline.prompt.PromptItem
Get the text to display for this item.
getText() - Method in interface org.jline.prompt.SeparatorItem
Get the separator text.
getText() - Method in interface org.jline.prompt.TextPrompt
Get the text to display.
getTitle() - Method in interface org.jline.prompt.EditorPrompt
Get the title to display in the editor.
getTitle() - Method in class org.jline.prompt.impl.DefaultEditorPrompt
 
getTransformer() - Method in class org.jline.prompt.impl.DefaultPrompt
 
getTransformer() - Method in interface org.jline.prompt.Prompt
Get the transformer function that modifies how the answer is displayed after submission.
getValidator() - Method in class org.jline.prompt.impl.DefaultInputPrompt
 
getValidator() - Method in interface org.jline.prompt.InputPrompt
Get the validator.
getValueFunction() - Method in class org.jline.prompt.impl.DefaultSearchPrompt
 
getValueFunction() - Method in interface org.jline.prompt.SearchPrompt
Get the function to convert items to their values.

H

hashCode() - Method in class org.jline.prompt.impl.DefaultSeparatorItem
 
hasValue(Map<String, ? extends PromptResult<? extends Prompt>>, String) - Static method in class org.jline.prompt.DynamicPromptHelper
Checks if a result exists and has a non-empty value.
helpText(String) - Method in interface org.jline.prompt.ChoiceBuilder
Set the help text for the current choice.
helpText(String) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Set the help text for the current choice.
hint(String) - Method in class org.jline.prompt.impl.DefaultKeyPressBuilder
 
hint(String) - Method in interface org.jline.prompt.KeyPressBuilder
Set the hint text displayed to the user.

I

Immutability - Search tag in interface org.jline.prompt.PromptResult
Section
Implementation Requirements - Search tag in interface org.jline.prompt.BaseBuilder
Section
ImprovedDynamicPromptExample - Class in org.jline.prompt.examples
Improved example demonstrating dynamic prompting using the DynamicPromptHelper utility.
in() - Method in class org.jline.prompt.PromptCommands.Context
 
inactiveLabel(String) - Method in class org.jline.prompt.impl.DefaultToggleBuilder
 
inactiveLabel(String) - Method in interface org.jline.prompt.ToggleBuilder
Set the label for the inactive (off) state.
indicator() - Method in class org.jline.prompt.impl.DefaultPrompterConfig
 
indicator() - Method in interface org.jline.prompt.PrompterConfig
Get the indicator character/string.
initialText(String) - Method in interface org.jline.prompt.EditorBuilder
Set the initial text for the editor.
initialText(String) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
InputBuilder - Interface in org.jline.prompt
Builder for creating text input prompts with advanced features.
InputPrompt - Interface in org.jline.prompt
Interface for input prompts.
InputResult - Interface in org.jline.prompt
Result of an input prompt.
Input with Completion - Search tag in interface org.jline.prompt.InputBuilder
Section
Input with Validation - Search tag in interface org.jline.prompt.InputBuilder
Section
INSTANCE - Static variable in class org.jline.prompt.impl.DefaultNoResult
Singleton instance of DefaultNoResult.
INSTANCE - Static variable in interface org.jline.prompt.NoResult
Singleton instance of NoResult.
invalidNumberMessage(String) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
invalidNumberMessage(String) - Method in interface org.jline.prompt.NumberBuilder
Set the error message for invalid numbers.
isActive() - Method in class org.jline.prompt.impl.DefaultToggleResult
 
isActive() - Method in interface org.jline.prompt.ToggleResult
Get the selected value.
isConfirmed() - Method in interface org.jline.prompt.ConfirmResult
Check if the user confirmed (answered YES).
isConfirmed() - Method in class org.jline.prompt.impl.DefaultConfirmResult
 
isDefaultChoice() - Method in interface org.jline.prompt.ChoiceItem
Whether this choice is the default choice.
isDefaultChoice() - Method in class org.jline.prompt.impl.DefaultChoiceItem
 
isDisabled() - Method in class org.jline.prompt.impl.DefaultCheckboxItem
 
isDisabled() - Method in class org.jline.prompt.impl.DefaultListItem
 
isDisabled() - Method in interface org.jline.prompt.PromptItem
Whether this item is disabled.
isDisabled() - Method in interface org.jline.prompt.SeparatorItem
Separators are never disabled.
isFilterable() - Method in interface org.jline.prompt.CheckboxPrompt
Whether the checkbox list supports inline text filtering.
isFilterable() - Method in class org.jline.prompt.impl.DefaultCheckboxPrompt
 
isFilterable() - Method in class org.jline.prompt.impl.DefaultListPrompt
 
isFilterable() - Method in interface org.jline.prompt.ListPrompt
Whether the list supports inline text filtering.
isInitiallyChecked() - Method in interface org.jline.prompt.CheckboxItem
Whether this checkbox is initially checked.
isInitiallyChecked() - Method in class org.jline.prompt.impl.DefaultCheckboxItem
 
isInitiallyChecked() - Method in interface org.jline.prompt.SeparatorItem
Separators are never initially checked.
isSelectable() - Method in interface org.jline.prompt.PromptItem
Whether this item is selectable.
isSelectable() - Method in interface org.jline.prompt.SeparatorItem
Separators are never selectable.

K

key(char) - Method in interface org.jline.prompt.ChoiceBuilder
Set the key for the current choice.
key(char) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Set the key for the current choice.
Key Features - Search tag in package org.jline.prompt
Section
KeyPressBuilder - Interface in org.jline.prompt
Builder for key press prompts.
KeyPressPrompt - Interface in org.jline.prompt
Interface for key press prompts.
KeyPressResult - Interface in org.jline.prompt
Result of a key press prompt.

L

lineReader(LineReader) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the line reader to use.
lineReader(LineReader) - Method in interface org.jline.prompt.InputBuilder
Set a custom line reader for advanced input handling.
ListBuilder - Interface in org.jline.prompt
Builder for list prompts.
ListItem - Interface in org.jline.prompt
Interface for list items in the Prompt.
ListPrompt - Interface in org.jline.prompt
Interface for list prompts.
ListResult - Interface in org.jline.prompt
Result of a list choice.
ListSeparatorBuilder - Interface in org.jline.prompt
Builder interface for list separators.

M

main(String[]) - Static method in class org.jline.prompt.examples.DynamicPromptExample
 
main(String[]) - Static method in class org.jline.prompt.examples.ImprovedDynamicPromptExample
 
main(String[]) - Static method in class org.jline.prompt.examples.PromptCommandExample
 
mask(Character) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the mask character for the input.
mask(Character) - Method in class org.jline.prompt.impl.DefaultPasswordBuilder
 
mask(Character) - Method in interface org.jline.prompt.InputBuilder
Set the character used to mask input for sensitive data.
mask(Character) - Method in interface org.jline.prompt.PasswordBuilder
Set the mask character.
max(Double) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
max(Double) - Method in interface org.jline.prompt.NumberBuilder
Set the maximum allowed value.
maxResults(int) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
maxResults(int) - Method in interface org.jline.prompt.SearchBuilder
Set the maximum number of results.
maxSelections(int) - Method in interface org.jline.prompt.CheckboxBuilder
Set the maximum number of items that can be selected.
maxSelections(int) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
ME - Static variable in interface org.jline.prompt.PrompterConfig
Message text style
message - Variable in class org.jline.prompt.impl.DefaultPrompt
 
message(String) - Method in interface org.jline.prompt.BaseBuilder
Set the message displayed to the user for this prompt.
message(String) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Set the message to display to the user.
message(String) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Set the message to display to the user.
message(String) - Method in class org.jline.prompt.impl.DefaultConfirmBuilder
Set the message to display to the user.
message(String) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
message(String) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the message to display to the user.
message(String) - Method in class org.jline.prompt.impl.DefaultKeyPressBuilder
 
message(String) - Method in class org.jline.prompt.impl.DefaultListBuilder
Set the message to display to the user.
message(String) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
message(String) - Method in class org.jline.prompt.impl.DefaultPasswordBuilder
 
message(String) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
message(String) - Method in class org.jline.prompt.impl.DefaultTextBuilder
Set the message for this text display.
message(String) - Method in class org.jline.prompt.impl.DefaultToggleBuilder
 
Message Guidelines: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Message Guidelines: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Message Guidelines: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Message Guidelines: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Message Guidelines: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Message Guidelines: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Message Guidelines: - Search tag in org.jline.prompt.BaseBuilder.message(String)
Section
Migration from jline-console-ui - Search tag in package org.jline.prompt
Section
min(Double) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
min(Double) - Method in interface org.jline.prompt.NumberBuilder
Set the minimum allowed value.
minSearchLength(int) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
minSearchLength(int) - Method in interface org.jline.prompt.SearchBuilder
Set the minimum search length.
minSelections(int) - Method in interface org.jline.prompt.CheckboxBuilder
Set the minimum number of items that must be selected.
minSelections(int) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 

N

name - Variable in class org.jline.prompt.impl.DefaultPrompt
 
name(String) - Method in interface org.jline.prompt.BaseBuilder
Set the unique identifier for this prompt.
name(String) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Set the name of this prompt.
name(String) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Set the name of this prompt.
name(String) - Method in class org.jline.prompt.impl.DefaultConfirmBuilder
Set the name of this prompt.
name(String) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
name(String) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the name of this prompt.
name(String) - Method in class org.jline.prompt.impl.DefaultKeyPressBuilder
 
name(String) - Method in class org.jline.prompt.impl.DefaultListBuilder
Set the name of this prompt.
name(String) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
name(String) - Method in class org.jline.prompt.impl.DefaultPasswordBuilder
 
name(String) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
name(String) - Method in class org.jline.prompt.impl.DefaultTextBuilder
Set the name of this text.
name(String) - Method in class org.jline.prompt.impl.DefaultToggleBuilder
 
Naming Guidelines: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Naming Guidelines: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Naming Guidelines: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Naming Guidelines: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Naming Guidelines: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Naming Guidelines: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
Naming Guidelines: - Search tag in org.jline.prompt.BaseBuilder.name(String)
Section
newBuilder() - Method in class org.jline.prompt.impl.DefaultPrompter
 
newBuilder() - Method in interface org.jline.prompt.Prompter
Get a builder for creating prompts.
newChoice(String) - Method in interface org.jline.prompt.ChoiceBuilder
Create a new choice with the given ID.
newChoice(String) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Create a new choice with the given ID.
newItem(String) - Method in interface org.jline.prompt.CheckboxBuilder
Create a new item with the given ID.
newItem(String) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Create a new item with the given ID.
newItem(String) - Method in class org.jline.prompt.impl.DefaultListBuilder
Create a new item with the given ID.
newItem(String) - Method in interface org.jline.prompt.ListBuilder
Create a new item with the given ID.
newSeparator() - Method in interface org.jline.prompt.CheckboxBuilder
Create a new separator with no text.
newSeparator() - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
newSeparator() - Method in class org.jline.prompt.impl.DefaultListBuilder
 
newSeparator() - Method in interface org.jline.prompt.ListBuilder
Create a new separator with no text.
newSeparator(String) - Method in interface org.jline.prompt.CheckboxBuilder
Create a new separator with the given text.
newSeparator(String) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
newSeparator(String) - Method in class org.jline.prompt.impl.DefaultListBuilder
 
newSeparator(String) - Method in interface org.jline.prompt.ListBuilder
Create a new separator with the given text.
NO - Enum constant in enum class org.jline.prompt.ConfirmResult.ConfirmationValue
 
NoResult - Interface in org.jline.prompt
A result that represents no result.
NumberBuilder - Interface in org.jline.prompt
Builder interface for number prompts.
NumberPrompt - Interface in org.jline.prompt
Interface for number prompts.

O

org.jline.prompt - module org.jline.prompt
JLine Prompt Module.
org.jline.prompt - package org.jline.prompt
JLine Prompt API - Interactive Console Prompts for Java Applications.
org.jline.prompt.examples - package org.jline.prompt.examples
 
org.jline.prompt.impl - package org.jline.prompt.impl
Implementation classes for the JLine Prompt API.
out() - Method in class org.jline.prompt.PromptCommands.Context
 
outOfRangeMessage(String) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
outOfRangeMessage(String) - Method in interface org.jline.prompt.NumberBuilder
Set the error message for out-of-range numbers.
Overview - Search tag in package org.jline.prompt
Section

P

pageSize(int) - Method in interface org.jline.prompt.CheckboxBuilder
Set the page size for pagination.
pageSize(int) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
pageSize(int) - Method in class org.jline.prompt.impl.DefaultListBuilder
 
pageSize(int) - Method in interface org.jline.prompt.ListBuilder
Set the page size for pagination.
PasswordBuilder - Interface in org.jline.prompt
Builder interface for password prompts.
Password Input - Search tag in interface org.jline.prompt.InputBuilder
Section
PasswordPrompt - Interface in org.jline.prompt
Interface for password prompts.
placeholder(String) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
placeholder(String) - Method in interface org.jline.prompt.SearchBuilder
Set the placeholder text.
PR - Static variable in interface org.jline.prompt.PrompterConfig
Prompt text style
prompt(List<AttributedString>, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>) - Method in class org.jline.prompt.impl.DefaultPrompter
 
prompt(List<AttributedString>, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>) - Method in interface org.jline.prompt.Prompter
Execute prompts dynamically based on previous user responses.
prompt(List<AttributedString>, List<? extends Prompt>) - Method in class org.jline.prompt.impl.DefaultPrompter
 
prompt(List<AttributedString>, List<? extends Prompt>) - Method in interface org.jline.prompt.Prompter
Execute a list of prompts and collect user responses.
prompt(PromptCommands.Context, Object[]) - Static method in class org.jline.prompt.PromptCommands
Object array version for compatibility.
prompt(PromptCommands.Context, String[]) - Static method in class org.jline.prompt.PromptCommands
Prompt command - create interactive prompts.
Prompt - Interface in org.jline.prompt
Interface for all promptable elements in the Prompter.
PromptBuilder - Interface in org.jline.prompt
Interface for building prompts in the Prompter.
PromptCommandExample - Class in org.jline.prompt.examples
Example demonstrating the PromptCommands usage.
PromptCommands - Class in org.jline.prompt
Prompt command implementations for JLine applications.
PromptCommands.Context - Class in org.jline.prompt
Context for command execution, providing I/O streams and current directory.
promptElement(List<AttributedString>, Prompt, PromptResult<? extends Prompt>) - Method in class org.jline.prompt.impl.DefaultPrompter
Execute a single prompt element (like ConsolePrompt.promptElement).
Prompter - Interface in org.jline.prompt
Main interface for the JLine Prompt API.
PrompterConfig - Interface in org.jline.prompt
Configuration interface for customizing the visual appearance and behavior of prompts.
PrompterFactory - Class in org.jline.prompt
Factory for creating Prompter instances.
promptInternal(List<AttributedString>, List<? extends Prompt>, Map<String, PromptResult<? extends Prompt>>, boolean) - Method in class org.jline.prompt.impl.DefaultPrompter
Internal prompt method that mirrors ConsolePrompt.prompt() logic.
PromptItem - Interface in org.jline.prompt
Interface for all UI items in the Prompter.
PromptResult<T> - Interface in org.jline.prompt
Parameterized interface representing the result of a user prompt interaction.

R

resultEqualsAny(Map<String, ? extends PromptResult<? extends Prompt>>, String, String...) - Static method in class org.jline.prompt.DynamicPromptHelper
Checks if a result equals any of the given values.

S

SE - Static variable in interface org.jline.prompt.PrompterConfig
Selected item style
SearchBuilder<T> - Interface in org.jline.prompt
Builder interface for search prompts.
searchFunction(Function<String, List<T>>) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
searchFunction(Function<String, List<T>>) - Method in interface org.jline.prompt.SearchBuilder
Set the search function.
SearchPrompt<T> - Interface in org.jline.prompt
Interface for search prompts.
SearchResult<T> - Interface in org.jline.prompt
Result of a search prompt.
SeparatorItem - Interface in org.jline.prompt
Interface for separator items in lists and checkboxes.
setFilter(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultPrompt
 
setTransformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultPrompt
 
showLineNumbers() - Method in interface org.jline.prompt.EditorPrompt
Whether to show line numbers in the editor.
showLineNumbers() - Method in class org.jline.prompt.impl.DefaultEditorPrompt
 
showLineNumbers(boolean) - Method in interface org.jline.prompt.EditorBuilder
Set whether to show line numbers.
showLineNumbers(boolean) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
showMask() - Method in class org.jline.prompt.impl.DefaultPasswordPrompt
 
showMask() - Method in interface org.jline.prompt.PasswordPrompt
Whether to show the mask character or completely hide input.
showMask(boolean) - Method in class org.jline.prompt.impl.DefaultPasswordBuilder
 
showMask(boolean) - Method in interface org.jline.prompt.PasswordBuilder
Set whether to show the mask character or hide input completely.
showPageIndicator() - Method in interface org.jline.prompt.CheckboxPrompt
Whether to show a loop indicator when pagination is enabled.
showPageIndicator() - Method in class org.jline.prompt.impl.DefaultCheckboxPrompt
 
showPageIndicator() - Method in class org.jline.prompt.impl.DefaultListPrompt
 
showPageIndicator() - Method in interface org.jline.prompt.ListPrompt
Whether to show a loop indicator when pagination is enabled.
showPageIndicator(boolean) - Method in interface org.jline.prompt.CheckboxBuilder
Set whether to show page indicators.
showPageIndicator(boolean) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
showPageIndicator(boolean) - Method in class org.jline.prompt.impl.DefaultListBuilder
 
showPageIndicator(boolean) - Method in interface org.jline.prompt.ListBuilder
Set whether to show page indicators.
style(String) - Method in interface org.jline.prompt.PrompterConfig
 
styleResolver() - Method in class org.jline.prompt.impl.DefaultPrompterConfig
 
styleResolver() - Method in interface org.jline.prompt.PrompterConfig
Get the style resolver for this configuration.
Supported Prompt Types - Search tag in package org.jline.prompt
Section

T

terminal() - Method in class org.jline.prompt.PromptCommands.Context
 
text(String) - Method in interface org.jline.prompt.CheckboxBuilder
Set the text for the current item.
text(String) - Method in interface org.jline.prompt.CheckboxSeparatorBuilder
Set the separator text.
text(String) - Method in interface org.jline.prompt.ChoiceBuilder
Set the text for the current choice.
text(String) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
Set the text for the current item.
text(String) - Method in class org.jline.prompt.impl.DefaultCheckboxSeparatorBuilder
 
text(String) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
Set the text for the current choice.
text(String) - Method in class org.jline.prompt.impl.DefaultListBuilder
Set the text for the current item.
text(String) - Method in class org.jline.prompt.impl.DefaultListSeparatorBuilder
 
text(String) - Method in class org.jline.prompt.impl.DefaultTextBuilder
Set the text to display.
text(String) - Method in interface org.jline.prompt.ListBuilder
Set the text for the current item.
text(String) - Method in interface org.jline.prompt.ListSeparatorBuilder
Set the separator text.
text(String) - Method in interface org.jline.prompt.TextBuilder
Set the text to display.
TextBuilder - Interface in org.jline.prompt
Builder for text displays.
TextPrompt - Interface in org.jline.prompt
Interface for text prompts.
Thread Safety - Search tag in interface org.jline.prompt.Prompter
Section
title(String) - Method in interface org.jline.prompt.EditorBuilder
Set the title for the editor.
title(String) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
ToggleBuilder - Interface in org.jline.prompt
Builder for toggle prompts.
TogglePrompt - Interface in org.jline.prompt
Interface for toggle prompts.
ToggleResult - Interface in org.jline.prompt
Result of a toggle prompt.
toString() - Method in class org.jline.prompt.impl.DefaultCheckboxItem
 
toString() - Method in class org.jline.prompt.impl.DefaultCheckboxResult
 
toString() - Method in class org.jline.prompt.impl.DefaultChoiceItem
 
toString() - Method in class org.jline.prompt.impl.DefaultChoiceResult
 
toString() - Method in class org.jline.prompt.impl.DefaultConfirmResult
 
toString() - Method in class org.jline.prompt.impl.DefaultEditorResult
 
toString() - Method in class org.jline.prompt.impl.DefaultInputResult
 
toString() - Method in class org.jline.prompt.impl.DefaultKeyPressResult
 
toString() - Method in class org.jline.prompt.impl.DefaultListItem
 
toString() - Method in class org.jline.prompt.impl.DefaultListResult
 
toString() - Method in class org.jline.prompt.impl.DefaultNoResult
 
toString() - Method in class org.jline.prompt.impl.DefaultSearchResult
 
toString() - Method in class org.jline.prompt.impl.DefaultSeparatorItem
 
toString() - Method in class org.jline.prompt.impl.DefaultToggleResult
 
transformer(Function<String, String>) - Method in interface org.jline.prompt.BaseBuilder
Set a transformer function that modifies how the answer is displayed after submission.
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultCheckboxBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultChoiceBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultConfirmBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultEditorBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the transformer function.
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultKeyPressBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultListBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultNumberBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultPasswordBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultTextBuilder
 
transformer(Function<String, String>) - Method in class org.jline.prompt.impl.DefaultToggleBuilder
 
Type Safety - Search tag in interface org.jline.prompt.PromptResult
Section

U

unavailable() - Method in class org.jline.prompt.impl.DefaultPrompterConfig
 
unavailable() - Method in interface org.jline.prompt.PrompterConfig
Get the unavailable item character/string.
uncheckedBox() - Method in class org.jline.prompt.impl.DefaultPrompterConfig
 
uncheckedBox() - Method in interface org.jline.prompt.PrompterConfig
Get the unchecked box character/string.
unix() - Static method in class org.jline.prompt.impl.DefaultPrompterConfig
 
unix() - Static method in interface org.jline.prompt.PrompterConfig
Create a configuration with Unix/Linux-specific defaults.
unix(StyleResolver) - Static method in class org.jline.prompt.impl.DefaultPrompterConfig
 
Usage Examples - Search tag in interface org.jline.prompt.PromptResult
Section
Use Cases: - Search tag in org.jline.prompt.InputBuilder.lineReader(LineReader)
Section
Use Cases: - Search tag in org.jline.prompt.Prompter.prompt(List<AttributedString>, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>)
Section
Use Cases: - Search tag in org.jline.prompt.Prompter.prompt(List<AttributedString>, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>)
Section

V

Validation: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Validation: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Validation: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Validation: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Validation: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Validation: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Validation: - Search tag in org.jline.prompt.BaseBuilder.addPrompt()
Section
Validation Examples: - Search tag in org.jline.prompt.InputBuilder.validator(Function<String, Boolean>)
Section
validator(Function<String, Boolean>) - Method in class org.jline.prompt.impl.DefaultInputBuilder
Set the validator to use.
validator(Function<String, Boolean>) - Method in interface org.jline.prompt.InputBuilder
Set a validator function to validate user input before accepting it.
valueFunction(Function<T, String>) - Method in class org.jline.prompt.impl.DefaultSearchBuilder
 
valueFunction(Function<T, String>) - Method in interface org.jline.prompt.SearchBuilder
Set the value function.
valueOf(String) - Static method in enum class org.jline.prompt.ConfirmResult.ConfirmationValue
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.jline.prompt.ConfirmResult.ConfirmationValue
Returns an array containing the constants of this enum class, in the order they are declared.
variables() - Method in class org.jline.prompt.PromptCommands.Context
 

W

when(Predicate<Map<String, ? extends PromptResult<? extends Prompt>>>, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>) - Static method in class org.jline.prompt.DynamicPromptHelper
Creates a conditional prompt provider that only shows prompts when a condition is met.
whenResultEquals(String, String, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>) - Static method in class org.jline.prompt.DynamicPromptHelper
Creates a prompt provider that only executes if a specific result has a specific value.
whenResultExists(String, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>) - Static method in class org.jline.prompt.DynamicPromptHelper
Creates a prompt provider that only executes if a specific result exists.
whenResultMissing(String, Function<Map<String, ? extends PromptResult<? extends Prompt>>, List<? extends Prompt>>) - Static method in class org.jline.prompt.DynamicPromptHelper
Creates a prompt provider that only executes if a specific result does NOT exist.
windows() - Static method in class org.jline.prompt.impl.DefaultPrompterConfig
 
windows() - Static method in interface org.jline.prompt.PrompterConfig
Create a configuration with Windows-specific defaults.
windows(StyleResolver) - Static method in class org.jline.prompt.impl.DefaultPrompterConfig
 
withCancellableFirstPrompt(boolean) - Method in interface org.jline.prompt.PrompterConfig
 

Y

YES - Enum constant in enum class org.jline.prompt.ConfirmResult.ConfirmationValue
 
A B C D E F G H I K L M N O P R S T U V W Y 
All Classes and Interfaces|All Packages|Constant Field Values