InteractiveConsoleProgressBarConsumer

java.lang.Object

me.tongfei.progressbar.ConsoleProgressBarConsumer

me.tongfei.progressbar.InteractiveConsoleProgressBarConsumer

All Implemented Interfaces:: Appendable, AutoCloseable, Consumer<String>, ProgressBarConsumer

public class InteractiveConsoleProgressBarConsumer extends ConsoleProgressBarConsumer

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

Since:: 0.9.0

Field Summary

Fields

Modifier and Type

Field

Description

private boolean

initialized

private int

position

Fields inherited from class ConsoleProgressBarConsumer
maxRenderedLength, out
Constructor Summary

Constructors

Constructor

Description

InteractiveConsoleProgressBarConsumer(PrintStream out)

InteractiveConsoleProgressBarConsumer(PrintStream out, int predefinedWidth)
Method Summary

Modifier and Type

Method

Description

void

accept(String str)

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

void

close()

Methods inherited from class ConsoleProgressBarConsumer
getMaxRenderedLength

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Consumer
andThen

Methods inherited from interface ProgressBarConsumer
append, append, append, clear

Field Details
- initialized
  
  private boolean initialized
- position
  
  private int position
Constructor Details
- InteractiveConsoleProgressBarConsumer
  
  public InteractiveConsoleProgressBarConsumer(PrintStream out)
- InteractiveConsoleProgressBarConsumer
  
  public InteractiveConsoleProgressBarConsumer(PrintStream out, int predefinedWidth)
Method Details
- accept
  
  public void accept(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 Consumer<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 AutoCloseable
  
  Specified by:
  
  close in interface ProgressBarConsumer
  
  Overrides:
  
  close in class ConsoleProgressBarConsumer