me.tongfei.progressbar

Class ProgressBar

java.lang.Object

me.tongfei.progressbar.ProgressBar

All Implemented Interfaces:

AutoCloseable

public class ProgressBar
extends Object
implements AutoCloseable

A console-based progress bar with minimal runtime overhead.

Author:

Tongfei Chen

Constructor Summary

Constructors

Constructor and Description
ProgressBar(String task, long initialMax) Creates a progress bar with the specific task name and initial maximum value.
ProgressBar(String task, long initialMax, int updateIntervalMillis)
ProgressBar(String task, long initialMax, int updateIntervalMillis, PrintStream os, ProgressBarStyle style, String unitName, long unitSize) Creates a progress bar with the specific task name, initial maximum value, customized update interval (default 1000 ms), the PrintStream to be used, and output style.
ProgressBar(String task, long initialMax, ProgressBarStyle style)

Method Summary

Modifier and Type	Method and Description
void	close() Stops this progress bar, effectively stops tracking the underlying process.
long	getCurrent() Returns the current progress.
String	getExtraMessage() Returns the extra message at the end of the progress bar.
long	getMax() Returns the maximum value of this progress bar.
String	getTask() Returns the name of this task.
ProgressBar	maxHint(long n) Gives a hint to the maximum value of the progress bar.
ProgressBar	setExtraMessage(String msg) Sets the extra message at the end of the progress bar.
ProgressBar	start() Deprecated. Please use the Java try-with-resource pattern instead.
ProgressBar	step() Advances this progress bar by one step.
ProgressBar	stepBy(long n) Advances this progress bar by a specific amount.
ProgressBar	stepTo(long n) Advances this progress bar to the specific progress value.
ProgressBar	stop() Deprecated. Please use the Java try-with-resource pattern instead.
static InputStream	wrap(InputStream is, ProgressBarBuilder pbb) Wraps an InputStream so that when read, a progress bar is shown to track the reading progress.
static InputStream	wrap(InputStream is, String task) Wraps an InputStream so that when read, a progress bar is shown to track the reading progress.
static <T> Iterable<T>	wrap(Iterable<T> ts, ProgressBarBuilder pbb) Wraps an Iterable so that when iterated, a progress bar is shown to track the traversal progress.
static <T> Iterable<T>	wrap(Iterable<T> ts, String task) Wraps an Iterable so that when iterated, a progress bar is shown to track the traversal progress.
static <T> Iterator<T>	wrap(Iterator<T> it, ProgressBarBuilder pbb) Wraps an iterator so that when iterated, a progress bar is shown to track the traversal progress.
static <T> Iterator<T>	wrap(Iterator<T> it, String task) Wraps an iterator so that when iterated, a progress bar is shown to track the traversal progress.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressBar

public ProgressBar(String task,
                   long initialMax)

Creates a progress bar with the specific task name and initial maximum value.

Parameters:

task - Task name

initialMax - Initial maximum value

ProgressBar

public ProgressBar(String task,
                   long initialMax,
                   ProgressBarStyle style)

ProgressBar

public ProgressBar(String task,
                   long initialMax,
                   int updateIntervalMillis)

ProgressBar

public ProgressBar(String task,
                   long initialMax,
                   int updateIntervalMillis,
                   PrintStream os,
                   ProgressBarStyle style,
                   String unitName,
                   long unitSize)

Creates a progress bar with the specific task name, initial maximum value, customized update interval (default 1000 ms), the PrintStream to be used, and output style.

Parameters:

task - Task name

initialMax - Initial maximum value

updateIntervalMillis - Update interval (default value 1000 ms)

os - Print stream (default value System.err)

style - Output style (default value ProgressBarStyle.UNICODE_BLOCK)

Method Detail

start

@Deprecated
public ProgressBar start()

Deprecated. Please use the Java try-with-resource pattern instead.

Starts this progress bar.

stepBy

public ProgressBar stepBy(long n)

Advances this progress bar by a specific amount.

Parameters:

n - Step size

stepTo

public ProgressBar stepTo(long n)

Advances this progress bar to the specific progress value.

Parameters:

n - New progress value

step

public ProgressBar step()

Advances this progress bar by one step.

maxHint

public ProgressBar maxHint(long n)

Gives a hint to the maximum value of the progress bar.

Parameters:

n - Hint of the maximum value

stop

@Deprecated
public ProgressBar stop()

Deprecated. Please use the Java try-with-resource pattern instead.

Stops this progress bar.

close

public void close()

Stops this progress bar, effectively stops tracking the underlying process.

Implements the AutoCloseable interface which enables the try-with-resource pattern with progress bars.

Specified by:

close in interface AutoCloseable

Since:

0.7.0

setExtraMessage

public ProgressBar setExtraMessage(String msg)

Sets the extra message at the end of the progress bar.

Parameters:

msg - New message

getCurrent

public long getCurrent()

Returns the current progress.

getMax

public long getMax()

Returns the maximum value of this progress bar.

getTask

public String getTask()

Returns the name of this task.

getExtraMessage

public String getExtraMessage()

Returns the extra message at the end of the progress bar.

wrap

public static <T> Iterator<T> wrap(Iterator<T> it,
                                   String task)

Wraps an iterator so that when iterated, a progress bar is shown to track the traversal progress.

Parameters:

it - Underlying iterator

task - Task name

wrap

public static <T> Iterator<T> wrap(Iterator<T> it,
                                   ProgressBarBuilder pbb)

Wraps an iterator so that when iterated, a progress bar is shown to track the traversal progress.

Parameters:

it - Underlying iterator

pbb - Progress bar builder

wrap

public static <T> Iterable<T> wrap(Iterable<T> ts,
                                   String task)

Wraps an Iterable so that when iterated, a progress bar is shown to track the traversal progress.

Sample usage: for (T x : ProgressBar.wrap(collection, "Traversal")) { ... }

Parameters:

ts - Underlying iterable

task - Task name

wrap

public static <T> Iterable<T> wrap(Iterable<T> ts,
                                   ProgressBarBuilder pbb)

Wraps an Iterable so that when iterated, a progress bar is shown to track the traversal progress. For this function the progress bar can be fully customized by using a ProgressBarBuilder.

Parameters:

ts - Underlying iterable

pbb - An instance of a ProgressBarBuilder

wrap

public static InputStream wrap(InputStream is,
                               String task)

Wraps an InputStream so that when read, a progress bar is shown to track the reading progress.

Parameters:

is - Input stream to be wrapped

task - Name of the progress

wrap

public static InputStream wrap(InputStream is,
                               ProgressBarBuilder pbb)

Wraps an InputStream so that when read, a progress bar is shown to track the reading progress. For this function the progress bar can be fully customized by using a ProgressBarBuilder.

Parameters:

is - Input stream to be wrapped

pbb - An instance of a ProgressBarBuilder