ConsoleProgressBarConsumer

java.lang.Object

me.tongfei.progressbar.ConsoleProgressBarConsumer

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

Direct Known Subclasses:: InteractiveConsoleProgressBarConsumer

public class ConsoleProgressBarConsumer extends Object implements ProgressBarConsumer

Progress bar consumer that prints the progress bar state to console. By default System.err is used as PrintStream.

Field Summary

Fields

Modifier and Type

Field

Description

private static int

consoleRightMargin

(package private) int

maxRenderedLength

(package private) final PrintStream

out
Constructor Summary

Constructors

Constructor

Description

ConsoleProgressBarConsumer(PrintStream out)

ConsoleProgressBarConsumer(PrintStream out, int maxRenderedLength)
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()

int

getMaxRenderedLength()

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

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

Field Details
- consoleRightMargin
  
  private static int consoleRightMargin
- maxRenderedLength
  
  int maxRenderedLength
- out
  
  final PrintStream out
Constructor Details
- ConsoleProgressBarConsumer
  
  public ConsoleProgressBarConsumer(PrintStream out)
- ConsoleProgressBarConsumer
  
  public ConsoleProgressBarConsumer(PrintStream out, int maxRenderedLength)
Method Details
- getMaxRenderedLength
  
  public int getMaxRenderedLength()
  
  Description copied from interface: ProgressBarConsumer
  
  Returns the maximum length allowed for the rendered form of a progress bar.
  
  Specified by:
  
  getMaxRenderedLength in interface ProgressBarConsumer
- 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
  
  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