- Documentation

[gpl/argeo-slc.git] / org.argeo.slc / src / main / java / org / argeo / slc / core / test / tree / AsynchronousTreeTestResultListener.java

diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/core/test/tree/AsynchronousTreeTestResultListener.java b/org.argeo.slc/src/main/java/org/argeo/slc/core/test/tree/AsynchronousTreeTestResultListener.java
index 6440fd2d1b765f6eadf8e36a5914749a9040d67a..76a8bb05a08071e93b9f7bb3a41c84d1557530e6 100644 (file)
--- a/org.argeo.slc/src/main/java/org/argeo/slc/core/test/tree/AsynchronousTreeTestResultListener.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/core/test/tree/AsynchronousTreeTestResultListener.java
@@ -8,6 +8,12 @@ import org.argeo.slc.core.test.TestResult;
 import org.argeo.slc.core.test.TestResultListener;\r
 import org.argeo.slc.core.test.TestResultPart;\r
 \r
+/**\r
+ * Abstract asynchronous implementation of a listener listening to a\r
+ * <code>TreeTestResult</code>.\r
+ * \r
+ * @see TreeTestResult\r
+ */\r
 public abstract class AsynchronousTreeTestResultListener implements\r
                TestResultListener, Runnable {\r
        private Vector<PartStruct> partStructs = new Vector<PartStruct>();\r
@@ -45,6 +51,7 @@ public abstract class AsynchronousTreeTestResultListener implements
                }\r
        }\r
 \r
+       /** Called when a result part has been added. */\r
        protected abstract void resultPartAdded(PartStruct partStruct);\r
 \r
        public void run() {\r
@@ -67,10 +74,15 @@ public abstract class AsynchronousTreeTestResultListener implements
                }\r
        }\r
 \r
+       /** Structure used to pass tree specific information to subclasses. */\r
        protected static class PartStruct {\r
+               /** The tree path of this part. */\r
                public final TreeSPath path;\r
+               /** The test result id of the related test result */\r
                public final NumericTRId resultId;\r
+               /** The part itself */\r
                public final TestResultPart part;\r
+               /** The tree test result itself. */\r
                public final TreeTestResult result;\r
 \r
                public PartStruct(TreeSPath path, NumericTRId resultId,\r