Index
All Classes and Interfaces|All Packages
A
- ALWAYS - Enum constant in enum class com.helixframework.console.Terminal.ColorMode
- AUTO - Enum constant in enum class com.helixframework.console.Terminal.ColorMode
B
- BLACK - Enum constant in enum class com.helixframework.console.Colors
- BLACK_BACKGROUND - Enum constant in enum class com.helixframework.console.Colors
- blank() - Method in class com.helixframework.console.ConsoleWriter
-
Convenience to separate logical chunks.
- BLUE - Enum constant in enum class com.helixframework.console.Colors
- BLUE_BACKGROUND - Enum constant in enum class com.helixframework.console.Colors
- BOLD - Enum constant in enum class com.helixframework.console.Colors
- BOLD_BLACK - Enum constant in enum class com.helixframework.console.Colors
- BOLD_BLUE - Enum constant in enum class com.helixframework.console.Colors
- BOLD_CYAN - Enum constant in enum class com.helixframework.console.Colors
- BOLD_GREEN - Enum constant in enum class com.helixframework.console.Colors
- BOLD_PURPLE - Enum constant in enum class com.helixframework.console.Colors
- BOLD_RED - Enum constant in enum class com.helixframework.console.Colors
- BOLD_WHITE - Enum constant in enum class com.helixframework.console.Colors
- BOLD_YELLOW - Enum constant in enum class com.helixframework.console.Colors
- build() - Method in class com.helixframework.console.ConsoleWriter.Builder
- build() - Method in class com.helixframework.console.progress.ProgressBar.Builder
-
Constructs and returns a new instance of the ProgressBar class using the configuration specified in the Builder.
- build() - Method in class com.helixframework.console.Prompt.Builder
-
Builds a Prompt object with the specified configuration.
- builder() - Static method in class com.helixframework.console.ConsoleWriter
- builder() - Static method in class com.helixframework.console.progress.ProgressBar
-
Creates a new instance of the Builder class for configuring and constructing a ProgressBar instance.
- builder(ConsoleReader, String) - Static method in class com.helixframework.console.Prompt
-
Creates a new instance of Builder class to build a Prompt object.
- Builder() - Constructor for class com.helixframework.console.ConsoleWriter.Builder
- Builder() - Constructor for class com.helixframework.console.progress.ProgressBar.Builder
- Builder(ConsoleReader, String) - Constructor for class com.helixframework.console.Prompt.Builder
-
Creates a new instance of Builder class to build a Prompt object.
C
- colorMode(Terminal.ColorMode) - Method in class com.helixframework.console.Prompt.Builder
-
Sets the color mode used by the prompt.
- Colors - Enum Class in com.helixframework.console
-
ANSI colors.
- com.helixframework.console - package com.helixframework.console
- com.helixframework.console.progress - package com.helixframework.console.progress
- ConsoleWriter - Class in com.helixframework.console
- ConsoleWriter.Builder - Class in com.helixframework.console
- CYAN - Enum constant in enum class com.helixframework.console.Colors
- CYAN_BACKGROUND - Enum constant in enum class com.helixframework.console.Colors
D
- defaultValue(String) - Method in class com.helixframework.console.Prompt.Builder
-
Sets the default value for the prompt.
- defaultValueColor(Colors) - Method in class com.helixframework.console.Prompt.Builder
-
Sets the color for the default value in the prompt.
- detail(String) - Method in class com.helixframework.console.ConsoleWriter
-
Indented block lines (nice for steps, details, stack traces, etc.).
- detail(String, Throwable) - Method in class com.helixframework.console.ConsoleWriter
-
Prints a detailed message with an accompanying stack trace.
E
- error(String) - Method in class com.helixframework.console.ConsoleWriter
G
- getCode() - Method in enum class com.helixframework.console.Colors
-
Returns the ANSI code.
- GREEN - Enum constant in enum class com.helixframework.console.Colors
- GREEN_BACKGROUND - Enum constant in enum class com.helixframework.console.Colors
H
- header(String) - Method in class com.helixframework.console.ConsoleWriter
I
- info(String) - Method in class com.helixframework.console.ConsoleWriter
- isInteractive() - Static method in class com.helixframework.console.Terminal
-
Determines whether the current terminal session is interactive.
N
- NEVER - Enum constant in enum class com.helixframework.console.Terminal.ColorMode
O
- open(String) - Static method in class com.helixframework.console.OpenInBrowser
-
Opens a URL in the default web browser.
- OpenInBrowser - Class in com.helixframework.console
-
Utility class for opening a URL in the default web browser.
- optional() - Method in class com.helixframework.console.Prompt.Builder
-
Specifies that the input for the prompt is optional.
P
- print(String) - Method in class com.helixframework.console.ConsoleWriter
- ProgressBar - Class in com.helixframework.console.progress
-
The ProgressBar class represents a customizable textual progress bar that can be used to visually display the progress of a process or task.
- ProgressBar.Builder - Class in com.helixframework.console.progress
-
Builder class for creating and configuring instances of ProgressBar.
- Prompt - Class in com.helixframework.console
-
Prompt class represents a command line prompt that reads user input from the console.
- Prompt.Builder - Class in com.helixframework.console
-
Builder class for creating Prompt objects.
- promptColor(Colors) - Method in class com.helixframework.console.Prompt.Builder
-
Sets the color for the prompt message.
- promptPrefix(String) - Method in class com.helixframework.console.Prompt.Builder
-
Sets the prefix for the prompt.
- promptSuffix(String) - Method in class com.helixframework.console.Prompt.Builder
-
Sets the suffix for the prompt.
- PURPLE - Enum constant in enum class com.helixframework.console.Colors
- PURPLE_BACKGROUND - Enum constant in enum class com.helixframework.console.Colors
R
- read() - Method in class com.helixframework.console.Prompt
-
Reads user input from the ConsoleReader object.
- RED - Enum constant in enum class com.helixframework.console.Colors
- RED_BACKGROUND - Enum constant in enum class com.helixframework.console.Colors
- reset() - Method in class com.helixframework.console.progress.ProgressBar
-
Resets the progress bar to its initial state.
- RESET - Enum constant in enum class com.helixframework.console.Colors
S
- setBarLength(int) - Method in class com.helixframework.console.progress.ProgressBar.Builder
-
Sets the length of the progress bar, which determines the number of characters used for the visual representation of the bar.
- setColorMode(Terminal.ColorMode) - Method in class com.helixframework.console.ConsoleWriter.Builder
- setEmptyChar(char) - Method in class com.helixframework.console.progress.ProgressBar.Builder
-
Sets the character used to represent the empty or incomplete portion of the progress bar.
- setErr(PrintStream) - Method in class com.helixframework.console.ConsoleWriter.Builder
- setLabel(String) - Method in class com.helixframework.console.progress.ProgressBar.Builder
-
Sets the label for the progress bar.
- setOut(PrintStream) - Method in class com.helixframework.console.ConsoleWriter.Builder
- setProgressChar(char) - Method in class com.helixframework.console.progress.ProgressBar.Builder
-
Sets the character used to represent the completed portion of the progress bar.
- shouldUseAnsi(Terminal.ColorMode) - Static method in class com.helixframework.console.Terminal
-
Determines if ANSI escape codes should be used based on the specified color mode and the interactivity of the current terminal session.
- success(String) - Method in class com.helixframework.console.ConsoleWriter
T
- Terminal - Class in com.helixframework.console
-
Terminal utility.
- Terminal.ColorMode - Enum Class in com.helixframework.console
-
Defines the available color modes for terminal output.
- toString() - Method in enum class com.helixframework.console.Colors
-
Returns the ANSI code.
- toString() - Method in class com.helixframework.console.progress.ProgressBar
U
- update(int) - Method in class com.helixframework.console.progress.ProgressBar
-
Updates the progress displayed by the progress bar to the specified value.
- update(int, String) - Method in class com.helixframework.console.progress.ProgressBar
-
Updates the progress bar with the specified progress value and optional progress text.
V
- valueOf(String) - Static method in enum class com.helixframework.console.Colors
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.helixframework.console.Terminal.ColorMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.helixframework.console.Colors
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.helixframework.console.Terminal.ColorMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- warn(String) - Method in class com.helixframework.console.ConsoleWriter
- WHITE - Enum constant in enum class com.helixframework.console.Colors
- WHITE_BACKGROUND - Enum constant in enum class com.helixframework.console.Colors
Y
- YELLOW - Enum constant in enum class com.helixframework.console.Colors
- YELLOW_BACKGROUND - Enum constant in enum class com.helixframework.console.Colors
All Classes and Interfaces|All Packages