A B C D E F G H I L M N P R S T U W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- accept(String) - Method in class me.tongfei.progressbar.ConsoleProgressBarConsumer
- accept(String) - Method in class me.tongfei.progressbar.DelegatingProgressBarConsumer
- accept(String) - Method in class me.tongfei.progressbar.InteractiveConsoleProgressBarConsumer
- accept(String) - Method in interface me.tongfei.progressbar.ProgressBarConsumer
-
Accepts a rendered form of a progress bar, e.g., prints to a specified stream.
- append(char) - Method in interface me.tongfei.progressbar.ProgressBarConsumer
- append(CharSequence) - Method in interface me.tongfei.progressbar.ProgressBarConsumer
- append(CharSequence, int, int) - Method in interface me.tongfei.progressbar.ProgressBarConsumer
- ASCII - Static variable in class me.tongfei.progressbar.ProgressBarStyle
-
Use only ASCII characters to draw the progress bar.
B
- block(char) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set block character.
- build() - Method in class me.tongfei.progressbar.ProgressBarBuilder
- build() - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Build
ProgressBarStyle. - builder() - Static method in class me.tongfei.progressbar.ProgressBar
-
Creates a new builder to customize a progress bar.
- builder() - Static method in class me.tongfei.progressbar.ProgressBarStyle
-
Creates a builder to build a custom progress bar style.
C
- characteristics() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedSpliterator
- clear() - Method in interface me.tongfei.progressbar.ProgressBarConsumer
-
Clears the progress bar from the display.
- clearDisplayOnFinish() - Method in class me.tongfei.progressbar.ProgressBarBuilder
- close() - Method in class me.tongfei.progressbar.ConsoleProgressBarConsumer
- close() - Method in class me.tongfei.progressbar.DelegatingProgressBarConsumer
- close() - Method in class me.tongfei.progressbar.InteractiveConsoleProgressBarConsumer
- close() - Method in class me.tongfei.progressbar.ProgressBar
-
Stops this progress bar, effectively stops tracking the underlying process.
- close() - Method in interface me.tongfei.progressbar.ProgressBarConsumer
- close() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- close() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterator
- close() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedOutputStream
- close() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- close() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedSpliterator
- close() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedWriter
- colorCode(byte) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set ANSI color code.
- COLORFUL_UNICODE_BAR - Static variable in class me.tongfei.progressbar.ProgressBarStyle
- COLORFUL_UNICODE_BLOCK - Static variable in class me.tongfei.progressbar.ProgressBarStyle
- ConsoleProgressBarConsumer - Class in me.tongfei.progressbar
-
Progress bar consumer that prints the progress bar state to console.
- ConsoleProgressBarConsumer(PrintStream) - Constructor for class me.tongfei.progressbar.ConsoleProgressBarConsumer
- ConsoleProgressBarConsumer(PrintStream, int) - Constructor for class me.tongfei.progressbar.ConsoleProgressBarConsumer
- continuousUpdate() - Method in class me.tongfei.progressbar.ProgressBarBuilder
D
- DefaultProgressBarRenderer - Class in me.tongfei.progressbar
-
Default progress bar renderer (see
ProgressBarRenderer). - DefaultProgressBarRenderer(ProgressBarStyle, String, long, boolean, DecimalFormat, ChronoUnit, boolean, Function<ProgressState, Optional<Duration>>) - Constructor for class me.tongfei.progressbar.DefaultProgressBarRenderer
- DelegatingProgressBarConsumer - Class in me.tongfei.progressbar
-
Progress bar consumer that delegates the progress bar handling to a custom
Consumer. - DelegatingProgressBarConsumer(Consumer<String>) - Constructor for class me.tongfei.progressbar.DelegatingProgressBarConsumer
- DelegatingProgressBarConsumer(Consumer<String>, int) - Constructor for class me.tongfei.progressbar.DelegatingProgressBarConsumer
- delimitingSequence(String) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set delimiting sequence.
E
- estimateSize() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedSpliterator
- etaString(ProgressState) - Method in class me.tongfei.progressbar.DefaultProgressBarRenderer
F
- flush() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedOutputStream
- flush() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedWriter
- fractionSymbols(String) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set fraction symbols.
G
- getComparator() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedSpliterator
- getCurrent() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the current progress.
- getCurrent() - Method in class me.tongfei.progressbar.ProgressState
- getElapsedAfterStart() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the duration that this progress bar has been running after it was resumed.
- getElapsedAfterStart() - Method in class me.tongfei.progressbar.ProgressState
- getElapsedBeforeStart() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the duration that this progress bar has been running before it was resumed.
- getElapsedBeforeStart() - Method in class me.tongfei.progressbar.ProgressState
- getExtraMessage() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the extra message at the end of the progress bar.
- getExtraMessage() - Method in class me.tongfei.progressbar.ProgressState
- getMax() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the maximum value of this progress bar.
- getMax() - Method in class me.tongfei.progressbar.ProgressState
- getMaxRenderedLength() - Method in class me.tongfei.progressbar.ConsoleProgressBarConsumer
- getMaxRenderedLength() - Method in class me.tongfei.progressbar.DelegatingProgressBarConsumer
- getMaxRenderedLength() - Method in interface me.tongfei.progressbar.ProgressBarConsumer
-
Returns the maximum length allowed for the rendered form of a progress bar.
- getNormalizedProgress() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the progress normalized to the interval [0, 1].
- getNormalizedProgress() - Method in class me.tongfei.progressbar.ProgressState
- getProgressBar() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- getProgressBar() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterator
- getProgressBar() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedOutputStream
- getProgressBar() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- getProgressBar() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedSpliterator
- getProgressBarBuilder() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterable
- getStart() - Method in class me.tongfei.progressbar.ProgressBar
- getStart() - Method in class me.tongfei.progressbar.ProgressState
- getStartInstant() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the instant when the progress bar started.
- getStartInstant() - Method in class me.tongfei.progressbar.ProgressState
- getTaskName() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the name of this task.
- getTaskName() - Method in class me.tongfei.progressbar.ProgressState
- getTotalElapsed() - Method in class me.tongfei.progressbar.ProgressBar
-
Returns the total duration that this progress bar has been running from start, excluding the period when it has been paused.
- getTotalElapsed() - Method in class me.tongfei.progressbar.ProgressState
H
- hasNext() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterator
- hideEta() - Method in class me.tongfei.progressbar.ProgressBarBuilder
I
- InteractiveConsoleProgressBarConsumer - Class in me.tongfei.progressbar
-
Progress bar consumer for terminals supporting moving cursor up/down.
- InteractiveConsoleProgressBarConsumer(PrintStream) - Constructor for class me.tongfei.progressbar.InteractiveConsoleProgressBarConsumer
- InteractiveConsoleProgressBarConsumer(PrintStream, int) - Constructor for class me.tongfei.progressbar.InteractiveConsoleProgressBarConsumer
- isAlive() - Method in class me.tongfei.progressbar.ProgressState
- isIndefinite() - Method in class me.tongfei.progressbar.ProgressBar
-
Checks if the progress bar is indefinite, i.e., its maximum value is unknown.
- isIndefinite() - Method in class me.tongfei.progressbar.ProgressState
- isPaused() - Method in class me.tongfei.progressbar.ProgressState
- iterator() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterable
L
- leftBracket(String) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set left bracket.
M
- mark(int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- mark(int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- maxHint(long) - Method in class me.tongfei.progressbar.ProgressBar
-
Gives a hint to the maximum value of the progress bar.
- me.tongfei.progressbar - module me.tongfei.progressbar
- me.tongfei.progressbar - package me.tongfei.progressbar
- me.tongfei.progressbar.wrapped - package me.tongfei.progressbar.wrapped
N
- next() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterator
P
- pause() - Method in class me.tongfei.progressbar.ProgressBar
-
Pauses this current progress.
- percentage(ProgressState) - Method in class me.tongfei.progressbar.DefaultProgressBarRenderer
- ProgressBar - Class in me.tongfei.progressbar
-
A console-based progress bar with minimal runtime overhead.
- ProgressBar(String, long) - Constructor for class me.tongfei.progressbar.ProgressBar
-
Creates a progress bar with the specific taskName name and initial maximum value.
- ProgressBar(String, long, int, boolean, boolean, long, Duration, ProgressBarRenderer, ProgressBarConsumer) - Constructor for class me.tongfei.progressbar.ProgressBar
-
Deprecated.Use
ProgressBarBuilderinstead. Will be private in future versions. - ProgressBar(String, long, int, boolean, boolean, PrintStream, ProgressBarStyle, String, long, boolean, DecimalFormat, ChronoUnit, long, Duration) - Constructor for class me.tongfei.progressbar.ProgressBar
-
Deprecated.Use
ProgressBarBuilderinstead. - ProgressBarBuilder - Class in me.tongfei.progressbar
-
Builder class for
ProgressBars. - ProgressBarBuilder() - Constructor for class me.tongfei.progressbar.ProgressBarBuilder
- ProgressBarConsumer - Interface in me.tongfei.progressbar
-
A consumer that prints a rendered progress bar.
- ProgressBarRenderer - Interface in me.tongfei.progressbar
-
Renders a
ProgressStateinto a string. - ProgressBarStyle - Class in me.tongfei.progressbar
-
Represents the display style of a progress bar.
- ProgressBarStyleBuilder - Class in me.tongfei.progressbar
-
Builder for
ProgressBarStyles. - ProgressBarStyleBuilder() - Constructor for class me.tongfei.progressbar.ProgressBarStyleBuilder
- ProgressBarWrappedInputStream - Class in me.tongfei.progressbar.wrapped
-
Any input stream whose progress is tracked by a progress bar.
- ProgressBarWrappedInputStream(InputStream, ProgressBar) - Constructor for class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- ProgressBarWrappedIterable<T> - Class in me.tongfei.progressbar.wrapped
-
Any iterable, when being iterated over, is tracked by a progress bar.
- ProgressBarWrappedIterable(Iterable<T>, ProgressBarBuilder) - Constructor for class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterable
- ProgressBarWrappedIterator<T> - Class in me.tongfei.progressbar.wrapped
-
Any iterator whose iteration is tracked by a progress bar.
- ProgressBarWrappedIterator(Iterator<T>, ProgressBar) - Constructor for class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterator
- ProgressBarWrappedOutputStream - Class in me.tongfei.progressbar.wrapped
- ProgressBarWrappedOutputStream(OutputStream, ProgressBar) - Constructor for class me.tongfei.progressbar.wrapped.ProgressBarWrappedOutputStream
- ProgressBarWrappedReader - Class in me.tongfei.progressbar.wrapped
-
A reader whose progress is tracked by a progress bar.
- ProgressBarWrappedReader(Reader, ProgressBar) - Constructor for class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- ProgressBarWrappedSpliterator<T> - Class in me.tongfei.progressbar.wrapped
-
Any spliterator whose parallel iteration is tracked by a multi-threaded progress bar.
- ProgressBarWrappedSpliterator(Spliterator<T>, ProgressBar) - Constructor for class me.tongfei.progressbar.wrapped.ProgressBarWrappedSpliterator
- ProgressBarWrappedWriter - Class in me.tongfei.progressbar.wrapped
-
A writer whose progress is tracked by a progress bar.
- ProgressBarWrappedWriter(Writer, ProgressBar) - Constructor for class me.tongfei.progressbar.wrapped.ProgressBarWrappedWriter
- progressFractionalPart(ProgressState, int) - Method in class me.tongfei.progressbar.DefaultProgressBarRenderer
- progressIntegralPart(ProgressState, int) - Method in class me.tongfei.progressbar.DefaultProgressBarRenderer
- ProgressState - Class in me.tongfei.progressbar
-
Encapsulates the internal states of a progress bar.
R
- ratio(ProgressState) - Method in class me.tongfei.progressbar.DefaultProgressBarRenderer
- read() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- read() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- read(byte[]) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- read(byte[], int, int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- read(char[]) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- read(char[], int, int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- refresh() - Method in class me.tongfei.progressbar.ProgressBar
-
Prompts the progress bar to refresh.
- refreshPrompt(String) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set refresh prompt.
- remove() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedIterator
- render(ProgressState, int) - Method in class me.tongfei.progressbar.DefaultProgressBarRenderer
- render(ProgressState, int) - Method in interface me.tongfei.progressbar.ProgressBarRenderer
-
Renders the current progress bar state as a string to be shown by a consumer.
- reset() - Method in class me.tongfei.progressbar.ProgressBar
-
Resets the progress bar to its initial state (where progress equals to 0).
- reset() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- reset() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- resume() - Method in class me.tongfei.progressbar.ProgressBar
-
Resumes this current progress.
- rightBracket(String) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set right bracket.
- rightSideFractionSymbol(char) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set right side fraction symbol.
S
- setConsumer(ProgressBarConsumer) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- setEtaFunction(Function<ProgressState, Optional<Duration>>) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- setExtraMessage(String) - Method in class me.tongfei.progressbar.ProgressBar
-
Sets the extra message at the end of the progress bar.
- setInitialMax(long) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- setMaxRenderedLength(int) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- setSpeedUnit(ChronoUnit) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- setStyle(ProgressBarStyle) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- setTaskName(String) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- setUnit(String, long) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- setUpdateIntervalMillis(int) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- showSpeed() - Method in class me.tongfei.progressbar.ProgressBarBuilder
- showSpeed(DecimalFormat) - Method in class me.tongfei.progressbar.ProgressBarBuilder
- skip(long) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedInputStream
- skip(long) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedReader
- space(char) - Method in class me.tongfei.progressbar.ProgressBarStyleBuilder
-
Set space character.
- speed(ProgressState) - Method in class me.tongfei.progressbar.DefaultProgressBarRenderer
- startsFrom(long, Duration) - Method in class me.tongfei.progressbar.ProgressBarBuilder
-
Sets elapsedBeforeStart duration and number of processed units.
- step() - Method in class me.tongfei.progressbar.ProgressBar
-
Advances this progress bar by one step.
- stepBy(long) - Method in class me.tongfei.progressbar.ProgressBar
-
Advances this progress bar by a specific amount.
- stepTo(long) - Method in class me.tongfei.progressbar.ProgressBar
-
Advances this progress bar to the specific progress value.
T
- TerminalUtils - Class in me.tongfei.progressbar
- TerminalUtils() - Constructor for class me.tongfei.progressbar.TerminalUtils
- tryAdvance(Consumer<? super T>) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedSpliterator
- trySplit() - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedSpliterator
U
- UNICODE_BLOCK - Static variable in class me.tongfei.progressbar.ProgressBarStyle
-
Use Unicode block characters to draw the progress bar.
W
- wrap(InputStream, String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an
InputStreamso that when read, a progress bar is shown to track the reading progress. - wrap(InputStream, ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an
InputStreamso that when read, a progress bar is shown to track the reading progress. - wrap(OutputStream, String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an
OutputStreamso that when written, a progress bar is shown to track the writing progress. - wrap(OutputStream, ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an
OutputStreamso that when written, a progress bar is shown to track the writing progress. - wrap(Reader, String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps a
Readerso that when read, a progress bar is shown to track the reading progress. - wrap(Reader, ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps a
Readerso that when read, a progress bar is shown to track the reading progress. - wrap(Writer, String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps a
Writerso that when written, a progress bar is shown to track the writing progress. - wrap(Writer, ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps a
Writerso that when written, a progress bar is shown to track the writing progress. - wrap(Iterable<T>, String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an
Iterableso that when iterated, a progress bar is shown to track the traversal progress. - wrap(Iterable<T>, ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an
Iterableso that when iterated, a progress bar is shown to track the traversal progress. - wrap(Iterator<T>, String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an iterator so that when iterated, a progress bar is shown to track the traversal progress.
- wrap(Iterator<T>, ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an iterator so that when iterated, a progress bar is shown to track the traversal progress.
- wrap(Spliterator<T>, String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps a
Spliteratorso that when iterated, a progress bar is shown to track the traversal progress. - wrap(Spliterator<T>, ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps a
Spliteratorso that when iterated, a progress bar is shown to track the traversal progress. - wrap(S, String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps a
Streamso that when iterated, a progress bar is shown to track the traversal progress. - wrap(S, ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps a
Streamso that when iterated, a progress bar is shown to track the traversal progress. - wrap(T[], String) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an array so that when iterated, a progress bar is shown to track the traversal progress.
- wrap(T[], ProgressBarBuilder) - Static method in class me.tongfei.progressbar.ProgressBar
-
Wraps an array so that when iterated, a progress bar is shown to track the traversal progress.
- write(byte[]) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedOutputStream
- write(byte[], int, int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedOutputStream
- write(char[], int, int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedWriter
- write(int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedOutputStream
- write(int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedWriter
- write(String) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedWriter
- write(String, int, int) - Method in class me.tongfei.progressbar.wrapped.ProgressBarWrappedWriter
All Classes All Packages