ProgressBar (progressbar 0.6.0 API)

java.lang.Object
- me.tongfei.progressbar.ProgressBar

```
public class ProgressBar
extends Object
```
A simple console-based progress bar.

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)` 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()` Starts this progress bar.
`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()` Stops this progress bar.
`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, 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)
```
    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 ProgresBarStyle.UNICODE_BLOCK)
- Method Detail
  - start
```
public ProgressBar start()
```
    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
```
public ProgressBar stop()
```
    Stops this progress bar.
  - 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> 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

Class ProgressBar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProgressBar

ProgressBar

ProgressBar

ProgressBar

Method Detail

start

stepBy

stepTo

step

maxHint

stop

setExtraMessage

getCurrent

getMax

getTask

getExtraMessage

wrap

wrap