adding java doc

git-svn-id: https://svn.argeo.org/slc/trunk@3857 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc

diff --git a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
index d9a3e66574903db85a9e2f93fab95756b42e76d3..187c3658966c29789fae23376c88af8ac34c7c0b 100644 (file)
--- a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
+++ b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
@@ -21,14 +21,26 @@ import java.util.Map;
 
 /**
  * 
- * @author bsinou
+ *         Implements both archetype and implementation of a given
+ *         process.
+ * 
+ *         At specification time, <code>executionSpec</code> represents the spec
+ *         of the parameters accepted by the process, with, among others: type,
+ *         default value and, optionally, possible values for each parameter. Thus
+ *         ExecutionSpec might be a huge object. Note that when marshalling only
+ *         a reference to a specific ExecutionSpec is stored in the XML to
+ *         optimize performance and avoid redundancy between various
+ *         ExecutionFlowDesciptor that might have the same ExecutionSpec.
  * 
- *         This class implements the archetype of a given process.
+ *         At runtime, we build a RealizedFlow which references an
+ *         ExecutionFlowDescriptor. As it happens AFTER marshalling /
+ *         unmarshalling process, the ExecutionSpec is null but we manage to
+ *         retrieve the ExecutionSpec and store it in the RealizedFlow, whereas
+ *         set values of the parameters are stored in the <code>values</code>
+ *         map.
+ * 
+ * @author bsinou
  * 
- *         WARNING : for now both <code>values</code> and
- *         <code>executionSpec</code> which are rundundant are used. Should be
- *         improved in further version. Note also that a third redundant field,
- *         <code>RealizedFlow.executionSpec</code> is also to be cleaned.
  * 
  */
 public class ExecutionFlowDescriptor implements Serializable {