Index

A B C E G H I M O P R S T
All Classes and Interfaces|All Packages

A

addCompletionCandidate(String) - Method in interface org.aesh.readline.completion.CompleteOperation

Add a completion candidate as a string.

addCompletionCandidate(String) - Method in class org.aesh.readline.completion.CompleteOperationImpl

addCompletionCandidate(TerminalString) - Method in interface org.aesh.readline.completion.CompleteOperation

Add a completion candidate.

addCompletionCandidate(TerminalString) - Method in class org.aesh.readline.completion.CompleteOperationImpl

addCompletionCandidates(List<String>) - Method in interface org.aesh.readline.completion.CompleteOperation

Add multiple completion candidates.

addCompletionCandidates(List<String>) - Method in class org.aesh.readline.completion.CompleteOperationImpl

addCompletionCandidatesTerminalString(List<TerminalString>) - Method in interface org.aesh.readline.completion.CompleteOperation

Add multiple completion candidates as TerminalStrings.

addCompletionCandidatesTerminalString(List<TerminalString>) - Method in class org.aesh.readline.completion.CompleteOperationImpl

ansi(String) - Method in class org.aesh.readline.prompt.Prompt.PromptBuilder

Sets the ANSI-formatted string for display.

B

build() - Method in class org.aesh.readline.prompt.Prompt.PromptBuilder

Builds a new Prompt instance from the configured parameters.

builder() - Static method in class org.aesh.readline.prompt.Prompt

Creates a new PromptBuilder for constructing Prompt instances.

C

characters(List<TerminalCharacter>) - Method in class org.aesh.readline.prompt.Prompt.PromptBuilder

Sets the prompt from a list of individually formatted TerminalCharacters.

complete(C) - Method in interface org.aesh.readline.completion.Completion

Populate the CompleteOperation object with possible completions + offset if needed

CompleteOperation - Interface in org.aesh.readline.completion

Interface representing a completion operation with candidates and configuration options.

CompleteOperationImpl - Class in org.aesh.readline.completion

A payload object to store completion data

CompleteOperationImpl(String, int) - Constructor for class org.aesh.readline.completion.CompleteOperationImpl

Creates a new CompleteOperationImpl with the given buffer and cursor position.

Completion<C extends CompleteOperation> - Interface in org.aesh.readline.completion

To enable auto completion, commands need to implement this interface.

CompositeSuggestionProvider - Class in org.aesh.readline.suggestion

A suggestion provider that chains multiple providers, returning the first non-null result.

CompositeSuggestionProvider(SuggestionProvider...) - Constructor for class org.aesh.readline.suggestion.CompositeSuggestionProvider

Constructor.

copy() - Method in class org.aesh.readline.prompt.Prompt

Creates a copy of this prompt.

E

equals(Object) - Method in class org.aesh.readline.prompt.Prompt

G

getANSI() - Method in class org.aesh.readline.prompt.Prompt

Returns the ANSI-formatted prompt string, or the plain prompt if no ANSI formatting exists.

getBuffer() - Method in interface org.aesh.readline.completion.CompleteOperation

Get the input buffer string.

getBuffer() - Method in class org.aesh.readline.completion.CompleteOperationImpl

getCompletionCandidates() - Method in interface org.aesh.readline.completion.CompleteOperation

Get the list of completion candidates.

getCompletionCandidates() - Method in class org.aesh.readline.completion.CompleteOperationImpl

getCursor() - Method in interface org.aesh.readline.completion.CompleteOperation

Get the current cursor position.

getCursor() - Method in class org.aesh.readline.completion.CompleteOperationImpl

getFormattedCompletion(String) - Method in interface org.aesh.readline.completion.CompleteOperation

Get the formatted version of a completion string.

getFormattedCompletion(String) - Method in class org.aesh.readline.completion.CompleteOperationImpl

getFormattedCompletionCandidates() - Method in interface org.aesh.readline.completion.CompleteOperation

Get the formatted completion candidates as strings.

getFormattedCompletionCandidates() - Method in class org.aesh.readline.completion.CompleteOperationImpl

getFormattedCompletionCandidatesTerminalString() - Method in interface org.aesh.readline.completion.CompleteOperation

Get the formatted completion candidates as TerminalStrings.

getFormattedCompletionCandidatesTerminalString() - Method in class org.aesh.readline.completion.CompleteOperationImpl

getLength() - Method in class org.aesh.readline.prompt.Prompt

Returns the length of the prompt in characters.

getMask() - Method in class org.aesh.readline.prompt.Prompt

Returns the masking character used for hiding input.

getNonTrimmedBuffer() - Method in class org.aesh.readline.completion.CompleteOperationImpl

Returns the original non-trimmed buffer.

getOffset() - Method in interface org.aesh.readline.completion.CompleteOperation

Get the offset for completion.

getOffset() - Method in class org.aesh.readline.completion.CompleteOperationImpl

getPromptCharacters() - Method in class org.aesh.readline.prompt.Prompt

Returns the prompt as an int array of characters.

getSeparator() - Method in interface org.aesh.readline.completion.CompleteOperation

Get the separator character, by default its space

getSeparator() - Method in class org.aesh.readline.completion.CompleteOperationImpl

Get the separator character, by default its space

getTrimmedSize() - Method in class org.aesh.readline.completion.CompleteOperationImpl

Returns the number of characters that were trimmed from the buffer.

H

hasANSI() - Method in class org.aesh.readline.prompt.Prompt

Checks if the prompt has ANSI formatting.

hashCode() - Method in class org.aesh.readline.prompt.Prompt

I

isAppendSeparator() - Method in interface org.aesh.readline.completion.CompleteOperation

Check if a separator should be appended after completion.

isAppendSeparator() - Method in class org.aesh.readline.completion.CompleteOperationImpl

isIgnoreNonEscapedSpace() - Method in interface org.aesh.readline.completion.CompleteOperation

Check if non-escaped spaces should be ignored.

isIgnoreNonEscapedSpace() - Method in class org.aesh.readline.completion.CompleteOperationImpl

isIgnoreOffset() - Method in interface org.aesh.readline.completion.CompleteOperation

Check if offset should be ignored.

isIgnoreOffset() - Method in class org.aesh.readline.completion.CompleteOperationImpl

isIgnoreStartsWith() - Method in interface org.aesh.readline.completion.CompleteOperation

Check if starts-with matching should be ignored.

isIgnoreStartsWith() - Method in class org.aesh.readline.completion.CompleteOperationImpl

isMasking() - Method in class org.aesh.readline.prompt.Prompt

Checks if input masking is enabled.

isTrimmed() - Method in class org.aesh.readline.completion.CompleteOperationImpl

Checks if the buffer has been trimmed.

M

mask(char) - Method in class org.aesh.readline.prompt.Prompt.PromptBuilder

Sets the mask character for hiding user input (e.g., for passwords).

message(String) - Method in class org.aesh.readline.prompt.Prompt.PromptBuilder

Sets the prompt text.

O

org.aesh.readline.completion - package org.aesh.readline.completion

org.aesh.readline.prompt - package org.aesh.readline.prompt

org.aesh.readline.suggestion - package org.aesh.readline.suggestion

P

Prompt - Class in org.aesh.readline.prompt

The Prompt: If created with a String value that value will be the prompt with the default back and foreground colors.

Prompt() - Constructor for class org.aesh.readline.prompt.Prompt

Creates an empty prompt.

Prompt(int[], Character) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a prompt with the specified code points and input masking character.

Prompt(String) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a prompt with the specified text.

Prompt(String, Character) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a prompt with the specified text and input masking character.

Prompt(String, String) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a prompt with the specified text and ANSI formatting.

Prompt(String, String, Character) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a prompt with the specified text, ANSI formatting, and input masking character.

Prompt(List<TerminalCharacter>) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a prompt from a list of terminal characters with individual formatting.

Prompt(List<TerminalCharacter>, Character) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a prompt from a list of terminal characters with individual formatting and an input masking character.

Prompt(Prompt) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a copy of the specified prompt.

Prompt(TerminalString) - Constructor for class org.aesh.readline.prompt.Prompt

Creates a prompt from a TerminalString with ANSI formatting.

Prompt.PromptBuilder - Class in org.aesh.readline.prompt

Builder for creating Prompt instances with a fluent API.

promptCodePoints(int[]) - Method in class org.aesh.readline.prompt.Prompt.PromptBuilder

Sets the prompt as an array of Unicode code points.

R

removeEscapedSpacesFromCompletionCandidates() - Method in interface org.aesh.readline.completion.CompleteOperation

Remove escaped spaces from all completion candidates.

removeEscapedSpacesFromCompletionCandidates() - Method in class org.aesh.readline.completion.CompleteOperationImpl

S

setAppendSeparator(boolean) - Method in interface org.aesh.readline.completion.CompleteOperation

Set if this CompletionOperation would allow a separator to be appended.

setAppendSeparator(boolean) - Method in class org.aesh.readline.completion.CompleteOperationImpl

setCompletionCandidates(List<String>) - Method in class org.aesh.readline.completion.CompleteOperationImpl

Sets the completion candidates from a list of strings.

setCompletionCandidatesTerminalString(List<TerminalString>) - Method in class org.aesh.readline.completion.CompleteOperationImpl

Sets the completion candidates from a list of TerminalString objects.

setIgnoreNonEscapedSpace(boolean) - Method in interface org.aesh.readline.completion.CompleteOperation

Set whether to ignore non-escaped spaces.

setIgnoreNonEscapedSpace(boolean) - Method in class org.aesh.readline.completion.CompleteOperationImpl

setIgnoreOffset(boolean) - Method in interface org.aesh.readline.completion.CompleteOperation

Set whether to ignore the offset.

setIgnoreOffset(boolean) - Method in class org.aesh.readline.completion.CompleteOperationImpl

setIgnoreStartsWith(boolean) - Method in interface org.aesh.readline.completion.CompleteOperation

Set whether to ignore starts-with matching.

setIgnoreStartsWith(boolean) - Method in class org.aesh.readline.completion.CompleteOperationImpl

setOffset(int) - Method in interface org.aesh.readline.completion.CompleteOperation

Set the offset for completion.

setOffset(int) - Method in class org.aesh.readline.completion.CompleteOperationImpl

setSeparator(char) - Method in interface org.aesh.readline.completion.CompleteOperation

By default the separator is one space char, but it can be overridden here.

setSeparator(char) - Method in class org.aesh.readline.completion.CompleteOperationImpl

By default the separator is one space char, but it can be overridden here.

suggest(String) - Method in class org.aesh.readline.suggestion.CompositeSuggestionProvider

suggest(String) - Method in interface org.aesh.readline.suggestion.SuggestionProvider

Returns the suggested suffix to display after the current buffer, or null for no suggestion.

SuggestionProvider - Interface in org.aesh.readline.suggestion

Provides inline ghost text suggestions based on the current buffer content.

T

terminalString(TerminalString) - Method in class org.aesh.readline.prompt.Prompt.PromptBuilder

Sets the prompt from a TerminalString with ANSI formatting.

toString() - Method in class org.aesh.readline.completion.CompleteOperationImpl

A B C E G H I M O P R S T
All Classes and Interfaces|All Packages