From: Niki Roo <niki@nikiroo.be>
Date: Tue, 7 Mar 2017 17:08:37 +0000 (+0100)
Subject: Fix progress tests, update Progress jDoc
X-Git-Tag: nikiroo-utils-1.4.0~4
X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=commitdiff_plain;h=da5bfa4878661329b6e13610d5596dc7d06a5455;ds=sidebyside

Fix progress tests, update Progress jDoc
---

diff --git a/src/be/nikiroo/utils/Progress.java b/src/be/nikiroo/utils/Progress.java
index a8940fc..62e4687 100644
--- 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
@@ -257,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
diff --git a/src/be/nikiroo/utils/test/ProgressTest.java b/src/be/nikiroo/utils/test/ProgressTest.java
index ff46bd6..c697973 100644
--- a/src/be/nikiroo/utils/test/ProgressTest.java
+++ b/src/be/nikiroo/utils/test/ProgressTest.java
@@ -95,7 +95,7 @@ class ProgressTest extends TestLauncher {
 
 					@Override
 					public void test() throws Exception {
-						Progress p = new Progress();
+						final Progress p = new Progress();
 						Progress child1 = new Progress();
 						Progress child2 = new Progress();
 						p.addProgress(child1, 50);
@@ -103,7 +103,7 @@ class ProgressTest extends TestLauncher {
 
 						p.addProgressListener(new Progress.ProgressListener() {
 							public void progress(Progress progress, String name) {
-								pg = progress.getProgress();
+								pg = p.getProgress();
 							}
 						});
 
@@ -121,7 +121,7 @@ class ProgressTest extends TestLauncher {
 
 					@Override
 					public void test() throws Exception {
-						Progress p = new Progress();
+						final Progress p = new Progress();
 						p.setMax(1000);
 
 						Progress child1 = new Progress();
@@ -133,7 +133,7 @@ class ProgressTest extends TestLauncher {
 
 						p.addProgressListener(new Progress.ProgressListener() {
 							public void progress(Progress progress, String name) {
-								pg = progress.getProgress();
+								pg = p.getProgress();
 							}
 						});
 
@@ -152,7 +152,7 @@ class ProgressTest extends TestLauncher {
 
 					@Override
 					public void test() throws Exception {
-						Progress p = new Progress();
+						final Progress p = new Progress();
 						p.setMax(1000);
 
 						Progress child1 = new Progress();
@@ -165,7 +165,7 @@ class ProgressTest extends TestLauncher {
 
 						p.addProgressListener(new Progress.ProgressListener() {
 							public void progress(Progress progress, String name) {
-								pg = progress.getProgress();
+								pg = p.getProgress();
 							}
 						});