svn commit: r16593 - trunk/src/argouml-app/src/org/argouml/notation/providers/uml/AbstractMessageNotationUml.java

Author: mvw
Date: 2009-01-13 23:10:17-0800
New Revision: 16593

Modified:
   trunk/src/argouml-app/src/org/argouml/notation/providers/uml/AbstractMessageNotationUml.java

Log:
Documented the plan of attack for issue 5150.
And some style updates.
No functional difference.

Modified: trunk/src/argouml-app/src/org/argouml/notation/providers/uml/AbstractMessageNotationUml.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-app/src/org/argouml/notation/providers/uml/AbstractMessageNotationUml.java?view=diff&pathrev=16593&r1=16592&r2=16593
==============================================================================
--- trunk/src/argouml-app/src/org/argouml/notation/providers/uml/AbstractMessageNotationUml.java	(original)
+++ trunk/src/argouml-app/src/org/argouml/notation/providers/uml/AbstractMessageNotationUml.java	2009-01-13 23:10:17-0800
@@ -79,8 +79,27 @@
  * is not even planned to be supported. The exceptions are intno, which
  * allows a number possibly followed by a sequence of letters in the range
  * 'a' - 'z', seqelem, which does not allow a recurrence, and message, which
- * does allow one recurrence near seq_expr. (formerly: name: action )
+ * does allow one recurrence near seq_expr. <p>
+ * 
+ * (formerly, the supported syntax was: name: action ) <p>
  *
+ * Generating a string from the model has some extra functionality:
+ * (to be implemented)
+ * If obtaining the Script of the Action returns an empty string, 
+ * then an alternative representation is given:
+ * If the action is a CallAction, use the name of its Operation, 
+ * and if it is a SendAction, the name of its Event.
+ * If also this returns no string, then we display the name of the Message. <p>
+ * 
+ *  Rationale:
+ *  This allows ArgoUML to show something on the diagram with older projects, 
+ *  which only had the name of the Message filled in by the user.
+ *  This also may improve the diagrams for imported XMI.<p>
+ *
+ * Parsing a text that is generated by one of the backup scenarios, 
+ * causes it to be written back in the script of the Action.
+ * Hence, editing the text on the diagram only once 
+ * causes the Action Script to be used from then on.
  *
  * @see MessageNotationUml
  * @see SDMessageNotationUml
@@ -97,11 +116,14 @@
      */
     private final List<CustomSeparator> parameterCustomSep;
 
+    /**
+     * An object containing an UML Message object.
+     */
     protected static class MsgPtr {
-            /**
-             * The message pointed to.
-             */
-            public Object message;
+        /**
+         * The message pointed to.
+         */
+        Object message;
     }
 
     /**
@@ -1490,8 +1512,8 @@
      * and return (a pointer to) the first Message in the chain.
      * 
      * @param message the UML Message to count the predecessors for
-     * @param ptr
-     * @return
+     * @param ptr an object to contain the returned first Message
+     * @return the number of messages in the chain
      */
     protected int recCountPredecessors(Object message, MsgPtr ptr) {
         int pre = 0;

------------------------------------------------------
http://argouml.tigris.org/ds/viewMessage.do?dsForumId=5905&dsMessageId=1023676

To unsubscribe from this discussion, e-mail: [[email protected]].