private List<ProgressListener> listeners;
private int min;
private int max;
- private int localProgress;
- private int progress; // children included
+ private double relativeLocalProgress;
+ private double relativeProgress; // children included
/**
* Create a new default unnamed {@link Progress}, from 0 to 100.
*/
public void setName(String name) {
this.name = name;
- changed(this);
+ changed(this, name);
}
/**
* @return the progress the value
*/
public int getProgress() {
- return progress;
+ return (int) Math.round(relativeProgress * (max - min));
}
/**
*/
public void setProgress(int progress) {
synchronized (getLock()) {
- int diff = this.progress - this.localProgress;
- this.localProgress = progress;
- setTotalProgress(this, name, progress + diff);
- }
- }
+ double childrenProgress = relativeProgress - relativeLocalProgress;
- /**
- * Check if the action corresponding to this {@link Progress} is done (i.e.,
- * if its progress value == its max value).
- *
- * @return TRUE if it is
- */
- public boolean isDone() {
- return progress >= max;
+ relativeLocalProgress = ((double) progress) / (max - min);
+
+ setRelativeProgress(this, name, relativeLocalProgress
+ + childrenProgress);
+ }
}
/**
* @return the progress
*/
public double getRelativeProgress() {
- return (((double) progress) / (max - min));
- }
-
- /**
- * Return the list of direct children of this {@link Progress}.
- *
- * @return the children (Who will think of the children??)
- */
- public Set<Progress> getChildren() {
- return children.keySet();
+ return relativeProgress;
}
/**
* Set the total progress value (including the optional children
- * {@link Progress}), on a {@link Progress#getMin()} to
- * {@link Progress#getMax()} scale.
+ * {@link Progress}), on a 0 to 1 scale.
*
* @param pg
* the {@link Progress} to report as the progression emitter
* the current name (if it is NULL, the first non-null name in
* the hierarchy will overwrite it) of the {@link Progress} who
* emitted this change
- * @param progress
+ * @param relativeProgress
* the progress to set
*/
- private void setTotalProgress(Progress pg, String name, int progress) {
+ private void setRelativeProgress(Progress pg, String name,
+ double relativeProgress) {
synchronized (getLock()) {
- progress = Math.max(min, progress);
- progress = Math.min(max, progress);
+ relativeProgress = Math.max(0, relativeProgress);
+ relativeProgress = Math.min(1, relativeProgress);
+ this.relativeProgress = relativeProgress;
- if (progress != this.progress) {
- this.progress = progress;
- changed(pg);
- }
+ changed(pg, name);
+ }
+ }
+
+ /**
+ * Get the total progress value (including the optional children
+ * {@link Progress}) on a 0 to 1 scale.
+ *
+ * @return the progress the value
+ */
+ private int getLocalProgress() {
+ return (int) Math.round(relativeLocalProgress * (max - min));
+ }
+
+ /**
+ * Add some value to the current progression of this {@link Progress}.
+ *
+ * @param step
+ * the amount to add
+ */
+ public void add(int step) {
+ synchronized (getLock()) {
+ setProgress(getLocalProgress() + step);
+ }
+ }
+
+ /**
+ * Check if the action corresponding to this {@link Progress} is done (i.e.,
+ * if its progress value == its max value).
+ *
+ * @return TRUE if it is
+ */
+ public boolean isDone() {
+ return getProgress() == max;
+ }
+
+ /**
+ * Mark the {@link Progress} as done by setting its value to max.
+ */
+ public void done() {
+ synchronized (getLock()) {
+ double childrenProgress = relativeProgress - relativeLocalProgress;
+ relativeLocalProgress = 1 - childrenProgress;
+ setRelativeProgress(this, name, 1d);
}
}
+ /**
+ * Return the list of direct children of this {@link Progress}.
+ *
+ * @return the children (Who will think of the children??)
+ */
+ public Set<Progress> getChildren() {
+ return children.keySet();
+ }
+
/**
* Notify the listeners that this {@link Progress} changed value.
*
* @param pg
* the emmiter
+ * @param name
+ * the current name (if it is NULL, the first non-null name in
+ * the hierarchy will overwrite it) of the {@link Progress} who
+ * emitted this change
*/
- private void changed(Progress pg) {
+ private void changed(Progress pg, String name) {
if (pg == null) {
pg = this;
}
+ if (name == null) {
+ name = this.name;
+ }
+
synchronized (getLock()) {
for (ProgressListener l : listeners) {
l.progress(pg, name);
}
progress.addProgressListener(new ProgressListener() {
+ @Override
public void progress(Progress pg, String name) {
synchronized (getLock()) {
- double total = ((double) localProgress) / (max - min);
+ double total = relativeLocalProgress;
for (Entry<Progress, Double> entry : children.entrySet()) {
total += (entry.getValue() / (max - min))
* entry.getKey().getRelativeProgress();
}
- if (name == null) {
- name = Progress.this.name;
- }
-
- setTotalProgress(pg, name,
- (int) Math.round(total * (max - min)));
+ setRelativeProgress(pg, name, total);
}
}
});