import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
-import java.util.Set;
/**
* Progress reporting system, possibly nested.
* @author niki
*/
public class Progress {
+ /**
+ * This event listener is designed to report progress events from
+ * {@link Progress}.
+ *
+ * @author niki
+ */
public interface ProgressListener extends EventListener {
/**
* A progression event.
* the min to set
*
*
- * @throws Error
+ * @throws RuntimeException
* if min < 0 or if min > max
*/
public void setMin(int min) {
if (min < 0) {
- throw new Error("negative values not supported");
+ throw new RuntimeException("negative values not supported");
}
synchronized (getLock()) {
if (min > max) {
- throw new Error(
+ throw new RuntimeException(
"The minimum progress value must be <= the maximum progress value");
}
* the max to set
*
*
- * @throws Error
+ * @throws RuntimeException
* if max < min
*/
public void setMax(int max) {
* @param max
* the max
*
- * @throws Error
+ * @throws RuntimeException
* if min < 0 or if min > max
*/
public void setMinMax(int min, int max) {
if (min < 0) {
- throw new Error("negative values not supported");
+ throw new RuntimeException("negative values not supported");
}
if (min > max) {
- throw new Error(
+ throw new RuntimeException(
"The minimum progress value must be <= the maximum progress value");
}
* @return TRUE if it is
*/
public boolean isDone() {
- return relativeProgress >= 1d;
+ return getProgress() == max;
}
/**
* Mark the {@link Progress} as done by setting its value to max.
*/
public void done() {
- setProgress(getMax());
+ synchronized (getLock()) {
+ double childrenProgress = relativeProgress - relativeLocalProgress;
+ relativeLocalProgress = 1 - childrenProgress;
+ setRelativeProgress(this, name, 1d);
+ }
}
/**
*
* @return the children (Who will think of the children??)
*/
- public Set<Progress> getChildren() {
- return children.keySet();
+ public List<Progress> getChildren() {
+ synchronized (getLock()) {
+ return new ArrayList<Progress>(children.keySet());
+ }
}
/**
* the listener
*/
public void addProgressListener(ProgressListener l) {
- this.listeners.add(l);
+ synchronized (getLock()) {
+ this.listeners.add(l);
+ }
}
/**
* @return TRUE if it was found (and removed)
*/
public boolean removeProgressListener(ProgressListener l) {
- return this.listeners.remove(l);
+ synchronized (getLock()) {
+ return this.listeners.remove(l);
+ }
}
/**
* {@link Progress#getMax()} scale) of this child
* {@link Progress} in relation to its parent
*
- * @throws Error
+ * @throws RuntimeException
* if weight exceed {@link Progress#getMax()} or if progress
* already has a parent
*/
public void addProgress(Progress progress, double weight) {
if (weight < min || weight > max) {
- throw new Error(String.format(
+ throw new RuntimeException(String.format(
"Progress object %s cannot have a weight of %f, "
- + "it is outside of its parent (%s) range (%f)",
+ + "it is outside of its parent (%s) range (%d)",
progress.name, weight, name, max));
}
if (progress.parent != null) {
- throw new Error(String.format(
+ throw new RuntimeException(String.format(
"Progress object %s cannot be added to %s, "
+ "as it already has a parent (%s)", progress.name,
name, progress.parent.name));
}
+ progress.parent = this;
+
progress.addProgressListener(new ProgressListener() {
@Override
public void progress(Progress pg, String name) {
synchronized (getLock()) {
double total = relativeLocalProgress;
- for (Entry<Progress, Double> entry : children.entrySet()) {
- total += (entry.getValue() / (max - min))
- * entry.getKey().getRelativeProgress();
+ synchronized (getLock()) {
+ for (Entry<Progress, Double> entry : children
+ .entrySet()) {
+ total += (entry.getValue() / (max - min))
+ * entry.getKey().getRelativeProgress();
+ }
}
setRelativeProgress(pg, name, total);
}
});
- this.children.put(progress, weight);
+ synchronized (getLock()) {
+ this.children.put(progress, weight);
+ }
}
/**