Bundle: fix memory leak at init/reset

[fanfix.git] / Progress.java

diff --git a/Progress.java b/Progress.java
index dea6be3fa011c351e4990b39e396368a50174e9d..bb143efaae10e7e21e7fe45c8617256450eb1e7b 100644 (file)
--- a/Progress.java
+++ b/Progress.java
@@ -9,6 +9,16 @@ import java.util.Map.Entry;
 
 /**
  * Progress reporting system, possibly nested.
+ * <p>
+ * A {@link Progress} can have a name, and that name will be reported through
+ * the event system (it will report the first non-null name in the stack from
+ * the {@link Progress} from which the event originated to the parent the event
+ * is listened on).
+ * <p>
+ * The {@link Progress} also has a table of keys/values shared amongst all the
+ * hierarchy (note that when adding a {@link Progress} to others, its values
+ * will be prioritized if some with the same keys were already present in the
+ * hierarchy).
  * 
  * @author niki
  */
@@ -35,6 +45,7 @@ public class Progress {
                public void progress(Progress progress, String name);
        }
 
+       private Map<Object, Object> map = new HashMap<Object, Object>();
        private Progress parent = null;
        private Object lock = new Object();
        private String name;
@@ -97,7 +108,7 @@ public class Progress {
        /**
         * The name of this {@link Progress} step.
         * 
-        * @return the name
+        * @return the name, can be NULL
         */
        public String getName() {
                return name;
@@ -230,8 +241,8 @@ public class Progress {
 
                        relativeLocalProgress = ((double) progress) / (max - min);
 
-                       setRelativeProgress(this, name, relativeLocalProgress
-                                       + childrenProgress);
+                       setRelativeProgress(this, name,
+                                       relativeLocalProgress + childrenProgress);
                }
        }
 
@@ -245,12 +256,26 @@ public class Progress {
                return relativeProgress;
        }
 
+       /**
+        * Set the total progress value (including the optional children
+        * {@link Progress}), on a 0 to 1 scale.
+        * <p>
+        * Will generate a changed event from this very {@link Progress}.
+        * 
+        * @param relativeProgress
+        *            the progress to set
+        */
+       public void setRelativeProgress(double relativeProgress) {
+               setRelativeProgress(this, name, relativeProgress);
+       }
+
        /**
         * Set the total progress value (including the optional children
         * {@link Progress}), on a 0 to 1 scale.
         * 
         * @param pg
-        *            the {@link Progress} to report as the progression emitter
+        *            the {@link Progress} to report as the progression emitter (can
+        *            be NULL, will then be considered the same as <tt>this</tt>)
         * @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
@@ -314,6 +339,8 @@ public class Progress {
 
        /**
         * Return the list of direct children of this {@link Progress}.
+        * <p>
+        * Can return an empty list, but never NULL.
         * 
         * @return the children (Who will think of the children??)
         */
@@ -323,6 +350,20 @@ public class Progress {
                }
        }
 
+       /**
+        * The weight of this children if it is actually a child of this.
+        * 
+        * @param child
+        *            the child to get the weight of
+        * 
+        * @return NULL if this is not a child of this
+        */
+       public Double getWeight(Progress child) {
+               synchronized (lock) {
+                       return children.get(child);
+               }
+       }
+
        /**
         * Notify the listeners that this {@link Progress} changed value.
         * 
@@ -405,8 +446,8 @@ public class Progress {
                if (progress.parent != null) {
                        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));
+                                                       + "as it already has a parent (%s)",
+                                       progress.name, name, progress.parent.name));
                }
 
                ProgressListener progressListener = new ProgressListener() {
@@ -425,9 +466,70 @@ public class Progress {
                };
 
                synchronized (lock) {
+                       // Should not happen but just in case
+                       if (this.map != progress.map) {
+                               this.map.putAll(progress.map);
+                       }
+                       progress.map = this.map;
                        progress.parent = this;
                        this.children.put(progress, weight);
                        progress.addProgressListener(progressListener);
                }
        }
+
+       /**
+        * Set the given value for the given key on this {@link Progress} and it's
+        * children.
+        * 
+        * @param key
+        *            the key
+        * @param value
+        *            the value
+        */
+       public void put(Object key, Object value) {
+               map.put(key, value);
+       }
+
+       /**
+        * Return the value associated with this key as a {@link String} if any,
+        * NULL if not.
+        * <p>
+        * If the value is not NULL but not a {@link String}, it will be converted
+        * via {@link Object#toString()}.
+        * 
+        * @param key
+        *            the key to check
+        * 
+        * @return the value or NULL
+        */
+       public String getString(Object key) {
+               Object value = map.get(key);
+               if (value == null) {
+                       return null;
+               }
+
+               return value.toString();
+       }
+
+       /**
+        * Return the value associated with this key if any, NULL if not.
+        * 
+        * @param key
+        *            the key to check
+        * 
+        * @return the value or NULL
+        */
+       public Object get(Object key) {
+               return map.get(key);
+       }
+
+       @Override
+       public String toString() {
+               return "[Progress]" //
+                               + (name == null || name.isEmpty() ? "" : " " + name) //
+                               + ": " + getProgress() + " / " + getMax() //
+                               + (children.isEmpty() ? ""
+                                               : " (with " + children.size() + " children)") //
+               ;
+       }
 }