X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;ds=sidebyside;f=src%2Fbe%2Fnikiroo%2Futils%2FProgress.java;h=bb143efaae10e7e21e7fe45c8617256450eb1e7b;hb=2e465ed3dc72efcdf96e419b39d6119c0cc41c6c;hp=748d4a666c377123ff2eadd29c840ec4baf402e5;hpb=7949d4a5098d8554c333c9fbbda469488bc66f7e;p=nikiroo-utils.git diff --git a/src/be/nikiroo/utils/Progress.java b/src/be/nikiroo/utils/Progress.java index 748d4a6..bb143ef 100644 --- a/src/be/nikiroo/utils/Progress.java +++ b/src/be/nikiroo/utils/Progress.java @@ -108,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; @@ -241,8 +241,8 @@ public class Progress { relativeLocalProgress = ((double) progress) / (max - min); - setRelativeProgress(this, name, relativeLocalProgress - + childrenProgress); + setRelativeProgress(this, name, + relativeLocalProgress + childrenProgress); } } @@ -256,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. + *
+ * 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 this) * @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 @@ -325,6 +339,8 @@ public class Progress { /** * Return the list of direct children of this {@link Progress}. + *
+ * Can return an empty list, but never NULL. * * @return the children (Who will think of the children??) */ @@ -334,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. * @@ -416,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() { @@ -492,4 +522,14 @@ public class Progress { 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)") // + ; + } }