Package uk.ac.manchester.spinnaker.utils.progress

Class ProgressBar

java.lang.Object

uk.ac.manchester.spinnaker.utils.progress.ProgressBar

All Implemented Interfaces:

Closeable, AutoCloseable

public class ProgressBar
extends Object
implements Closeable

Progress bar for telling the user where a task is up to and for reporting the duration.

The timer is started and the header of the bar is written during construction. The dash line is terminated when the last expected update arrives. (or if close() is called before that update). The timer is stopped and the duration written when close() is called. If close() is not called the duration is never written out.

Author:

Christian-B

Constructor Summary

Constructors

Constructor	Description
ProgressBar(int numberOfThings, String description)	Creates a Progress bar which outputs to System.out.
ProgressBar(int numberOfThings, String description, PrintStream output)	Creates a progress bar which outputs to the given PrintStream.

Method Summary

Modifier and Type	Method	Description
void	close()	Ends the Progress bar line and prints a duration line.
boolean	isClosed()
void	update()	Update the progress bar by a one unit.
void	update(int amountToAdd)	Update the progress bar by a given amount.

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressBar

public ProgressBar(int numberOfThings, String description, PrintStream output)

Creates a progress bar which outputs to the given PrintStream.

Parameters:

numberOfThings - The number of items to progress over

description - A text description to add at the start and when reporting duration.

output - The stream to write output too. For example System.out.

ProgressBar

public ProgressBar(int numberOfThings, String description)

Creates a Progress bar which outputs to System.out.

Parameters:

numberOfThings - The number of items to progress over

description - A text description to add at the start and when reporting duration.

Method Details

update

public void update(int amountToAdd)

Update the progress bar by a given amount.

Parameters:

amountToAdd - Amount of things to update by.

Throws:

IllegalStateException - Throws if the bar is updated too often or updated after it was closed.

update

public void update()

Update the progress bar by a one unit.

Throws:

IllegalStateException - Throws if the bar is updated too often or updated after it was closed.

close

public void close()

Ends the Progress bar line and prints a duration line.

If the bar is already closed then invoking this method has no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isClosed

public boolean isClosed()

Returns:

True if the progress bar is closed