de.jstacs.tools

Class ProgressUpdater

java.lang.Object

de.jstacs.tools.ProgressUpdater

public class ProgressUpdater
extends Object

Interface for a progress bar (or similar) indicating a tool's progress.

Author:

Jan Grau

Constructor Summary

Constructors

Constructor and Description
ProgressUpdater() Creates a new ProgressUpdater.

Method Summary

Modifier and Type	Method and Description
void	add(double val) Increases the internal current value.
double	getPercentage() Returns the percentage of a tool's work that has been completed so far.
boolean	isIndeterminate() Checks if this progress is indeterminate.
void	setCurrent(double curr) Sets the value corresponding to the current progress
void	setIndeterminate() Sets the progress to indeterminate.
void	setLast(double last) Sets the value that is reached upon completion of the monitored task.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressUpdater

public ProgressUpdater()

Creates a new ProgressUpdater.

Method Detail

setLast

public void setLast(double last)

Sets the value that is reached upon completion of the monitored task.

Parameters:

last - the final value

setCurrent

public void setCurrent(double curr)

Sets the value corresponding to the current progress

Parameters:

curr - the current value of progress

getPercentage

public double getPercentage()

Returns the percentage of a tool's work that has been completed so far.

Returns:

the percentage

setIndeterminate

public void setIndeterminate()

Sets the progress to indeterminate.

isIndeterminate

public boolean isIndeterminate()

Checks if this progress is indeterminate.

Returns:

if this progress is indeterminate

add

public void add(double val)

Increases the internal current value.

Parameters:

val - the value to be added to the current value