Fix progress tests, update Progress jDoc

[nikiroo-utils.git] / src / be / nikiroo / utils / Progress.java

diff --git a/src/be/nikiroo/utils/Progress.java b/src/be/nikiroo/utils/Progress.java
index b31cde49456174ef5fd5487f2feab00324a451f6..62e46874c3e0918ff49877f74b4d7314bae0be83 100644 (file)
--- a/src/be/nikiroo/utils/Progress.java
+++ b/src/be/nikiroo/utils/Progress.java
@@ -19,7 +19,10 @@ public class Progress {
                 * A progression event.
                 * 
                 * @param progress
-                *            the {@link Progress} object that generated it
+                *            the {@link Progress} object that generated it, not
+                *            necessarily the same as the one where the listener was
+                *            attached (it could be a child {@link Progress} of this
+                *            {@link Progress}).
                 * @param name
                 *            the first non-null name of the {@link Progress} step that
                 *            generated this event
@@ -93,6 +96,18 @@ public class Progress {
                return name;
        }
 
+       /**
+        * The name of this {@link Progress} step.
+        * 
+        * @param name
+        *            the new name
+        */
+       public void setName(String name) {
+               this.name = name;
+               // will fire an action event:
+               setProgress(this.localProgress);
+       }
+
        /**
         * The minimum progress value.
         * 
@@ -245,6 +260,10 @@ public class Progress {
 
        /**
         * Add a {@link ProgressListener} that will trigger on progress changes.
+        * <p>
+        * Note: the {@link Progress} that will be reported will be the active
+        * progress, not necessarily the same as the current one (it could be a
+        * child {@link Progress} of this {@link Progress}).
         * 
         * @param l
         *            the listener
@@ -253,6 +272,18 @@ public class Progress {
                this.listeners.add(l);
        }
 
+       /**
+        * Remove a {@link ProgressListener} that would trigger on progress changes.
+        * 
+        * @param l
+        *            the listener
+        * 
+        * @return TRUE if it was found (and removed)
+        */
+       public boolean removeProgressListener(ProgressListener l) {
+               return this.listeners.remove(l);
+       }
+
        /**
         * Add a child {@link Progress} of the given weight.
         * 
@@ -272,7 +303,7 @@ public class Progress {
                // Note: this is quite inefficient, especially with many children
                // TODO: improve it?
                progress.addProgressListener(new ProgressListener() {
-                       public void progress(Progress progress, String name) {
+                       public void progress(Progress pg, String name) {
                                double total = ((double) localProgress) / (max - min);
                                for (Entry<Progress, Double> entry : children.entrySet()) {
                                        total += (entry.getValue() / (max - min))
@@ -283,7 +314,7 @@ public class Progress {
                                        name = Progress.this.name;
                                }
 
-                               setTotalProgress(progress, name,
+                               setTotalProgress(pg, name,
                                                (int) Math.round(total * (max - min)));
                        }
                });