public sealed Enum ProgressBarPreset

Class Inheritance

extends Enum<ProgressBarPreset>

Annotations

Imports

io.github.kusoroadeolu.clique.internal.documentation.Stable

Predefined ProgressBarConfiguration presets with sensible defaults.

Each constant returns a fully built ProgressBarConfiguration via getConfiguration(). Presets can be used directly or as a starting point for further customization via ProgressBarConfiguration#fromPreset(ProgressBarPreset).

Available presets and their default values:

Preset defaults
Preset	Length	Complete	Incomplete	Format
BLOCKS	40	`█`	`░`	`:bar :percent% [:elapsed/:remaining]`
LINES	50	`▂`	`▁`	`:bar :percent%`
BOLD	40	`▰`	`▱`	`:bar :percent% \| :progress/:total`
CLASSIC	50	`#`	`=`	`[:bar] :percent% [:elapsed]`
DOTS	50	`●`	`○`	`:bar :percent%`

Example — customizing a preset:

ProgressBarConfiguration config = ProgressBarConfiguration.fromPreset(ProgressBarPreset.CLASSIC)
    .length(60)
    .build();

Field Summary

Modifier and Type	Field and Description
public static final ProgressBarPreset	BLOCKS Block-style bar using `█` and `░` characters.
public static final ProgressBarPreset	BOLD Bold-style bar using `▰` and `▱` characters.
public static final ProgressBarPreset	CLASSIC Classic ASCII bar using `#` and `=` characters.
public static final ProgressBarPreset	DOTS Dot-style bar using `●` and `○` characters.
public static final ProgressBarPreset	LINES Line-style bar using `▂` and `▁` characters.

Access	Constructor and Description
private	ProgressBarPreset()

Modifier and Type	Method and Description
public abstract ProgressBarConfiguration	Returns: a new `ProgressBarConfiguration`; never `null` getConfiguration() Returns a new `ProgressBarConfiguration` built from this preset's defaults.
public static ProgressBarPreset	valueOf(String name)
public static ProgressBarPreset[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

BLOCKS	back to summary
public static final ProgressBarPreset BLOCKS Block-style bar using `█` and `░` characters. Format: `:bar :percent% [:elapsed/:remaining]`. This is the preset used by `ProgressBarConfiguration#DEFAULT`.

BOLD	back to summary
public static final ProgressBarPreset BOLD Bold-style bar using `▰` and `▱` characters. Format: `:bar :percent% \| :progress/:total`.

CLASSIC	back to summary
public static final ProgressBarPreset CLASSIC Classic ASCII bar using `#` and `=` characters. Format: `[:bar] :percent% [:elapsed]`.

DOTS	back to summary
public static final ProgressBarPreset DOTS Dot-style bar using `●` and `○` characters. Format: `:bar :percent%`.

LINES	back to summary
public static final ProgressBarPreset LINES Line-style bar using `▂` and `▁` characters. Format: `:bar :percent%`.

ProgressBarPreset	back to summary
private ProgressBarPreset()

getConfiguration back to summary

getConfiguration	back to summary
public abstract ProgressBarConfiguration getConfiguration() Returns a new `ProgressBarConfiguration` built from this preset's defaults. Each call returns a distinct instance. To customize a preset's values, use `ProgressBarConfiguration#fromPreset(ProgressBarPreset)` instead, which returns a pre-seeded builder. Returns:ProgressBarConfiguration a new `ProgressBarConfiguration`; never `null`

public abstract ProgressBarConfiguration getConfiguration()

Returns a new ProgressBarConfiguration built from this preset's defaults.

Each call returns a distinct instance. To customize a preset's values, use ProgressBarConfiguration#fromPreset(ProgressBarPreset) instead, which returns a pre-seeded builder.

Returns:ProgressBarConfiguration: a new ProgressBarConfiguration; never null

valueOf	back to summary
public static ProgressBarPreset valueOf(String name)

values	back to summary
public static ProgressBarPreset[] values()