ProgressBarConsumer (progressbar 0.10.0 API)

All Superinterfaces:

java.lang.Appendable, java.lang.AutoCloseable, java.util.function.Consumer<java.lang.String>

All Known Implementing Classes:

ConsoleProgressBarConsumer, DelegatingProgressBarConsumer, InteractiveConsoleProgressBarConsumer
```
public interface ProgressBarConsumer
extends java.util.function.Consumer<java.lang.String>, java.lang.Appendable, java.lang.AutoCloseable
```
A consumer that prints a rendered progress bar.

Since:

0.8.0

Author:

Alex Peelman, Tongfei Chen

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`accept(java.lang.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(java.lang.CharSequence csq)`
`default ProgressBarConsumer`	`append(java.lang.CharSequence csq, int start, int end)`
`default void`	`clear()`	Clears the progress bar from the display.
`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(java.lang.String rendered)
```
    Accepts a rendered form of a progress bar, e.g., prints to a specified stream.
    
    Specified by:
    
    accept in interface java.util.function.Consumer<java.lang.String>
    
    Parameters:
    
    rendered - Rendered form of a progress bar, a string
  - clear
```
default void clear()
```
    Clears the progress bar from the display.
  - append
```
default ProgressBarConsumer append(java.lang.CharSequence csq)
```
    Specified by:
    
    append in interface java.lang.Appendable
  - append
```
default ProgressBarConsumer append(java.lang.CharSequence csq,
                                   int start,
                                   int end)
```
    Specified by:
    
    append in interface java.lang.Appendable
  - append
```
default ProgressBarConsumer append(char c)
```
    Specified by:
    
    append in interface java.lang.Appendable
  - close
```
void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable