me.tongfei.progressbar

Interface ProgressBarConsumer

All Superinterfaces:

Appendable, AutoCloseable, Consumer<String>

All Known Implementing Classes:

ConsoleProgressBarConsumer, DelegatingProgressBarConsumer, InteractiveConsoleProgressBarConsumer

public interface ProgressBarConsumer
extends Consumer<String>, Appendable, AutoCloseable

A consumer that prints a rendered progress bar.

Since:

0.8.0

Author:

Alex Peelman, Tongfei Chen

Method Summary

Modifier and Type	Method and Description
void	accept(String rendered) Accepts a rendered form of a progress bar, e.g., prints to a specified stream.
default ProgressBarConsumer	append(char c)
default ProgressBarConsumer	append(CharSequence csq)
default ProgressBarConsumer	append(CharSequence csq, int start, int end)
void	close()
int	getMaxRenderedLength() Returns the maximum length allowed for the rendered form of a progress bar.

Methods inherited from interface java.util.function.Consumer

andThen

Method Detail

getMaxRenderedLength

int getMaxRenderedLength()

Returns the maximum length allowed for the rendered form of a progress bar.

accept

void accept(String rendered)

Accepts a rendered form of a progress bar, e.g., prints to a specified stream.

Specified by:

accept in interface Consumer<String>

Parameters:

rendered - Rendered form of a progress bar, a string

append

default ProgressBarConsumer append(CharSequence csq)

Specified by:

append in interface Appendable

append

default ProgressBarConsumer append(CharSequence csq,
                                   int start,
                                   int end)

Specified by:

append in interface Appendable

append

default ProgressBarConsumer append(char c)

Specified by:

append in interface Appendable

close

void close()

Specified by:

close in interface AutoCloseable