Module me.tongfei.progressbar

Package me.tongfei.progressbar

Class InteractiveConsoleProgressBarConsumer

java.lang.Object

me.tongfei.progressbar.ConsoleProgressBarConsumer

me.tongfei.progressbar.InteractiveConsoleProgressBarConsumer

All Implemented Interfaces:

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

public class InteractiveConsoleProgressBarConsumer
extends ConsoleProgressBarConsumer

Progress bar consumer for terminals supporting moving cursor up/down.

Since:

0.9.0

Author:

Martin Vehovsky

Constructor Summary

Constructors

Constructor	Description
InteractiveConsoleProgressBarConsumer(java.io.PrintStream out)
InteractiveConsoleProgressBarConsumer(java.io.PrintStream out, int predefinedWidth)

Method Summary

Modifier and Type	Method	Description
void	accept(java.lang.String str)	Accepts a rendered form of a progress bar, e.g., prints to a specified stream.
void	close()

Methods inherited from class me.tongfei.progressbar.ConsoleProgressBarConsumer

getMaxRenderedLength

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface me.tongfei.progressbar.ProgressBarConsumer

append, append, append, clear

Constructor Detail

InteractiveConsoleProgressBarConsumer

public InteractiveConsoleProgressBarConsumer(java.io.PrintStream out)

InteractiveConsoleProgressBarConsumer

public InteractiveConsoleProgressBarConsumer(java.io.PrintStream out,
                                             int predefinedWidth)

Method Detail

accept

public void accept(java.lang.String str)

Description copied from interface: ProgressBarConsumer

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>

Specified by:

accept in interface ProgressBarConsumer

Overrides:

accept in class ConsoleProgressBarConsumer

Parameters:

str - Rendered form of a progress bar, a string

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ProgressBarConsumer

Overrides:

close in class ConsoleProgressBarConsumer