svn commit: r653899 - /commons/proper/scxml/branches/J6/src/main/java/org/apache/commons/scxml/SCXMLExecutor.java

[ra...@apache.org]

Author: rahul
Date: Tue May  6 13:07:06 2008
New Revision: 653899

URL: http://svn.apache.org/viewvc?rev=653899&view=rev
Log:
Port r653898 from trunk: Clarify one to many relationship between state machine definition and executor instance.

Modified:
    commons/proper/scxml/branches/J6/src/main/java/org/apache/commons/scxml/SCXMLExecutor.java

Modified: commons/proper/scxml/branches/J6/src/main/java/org/apache/commons/scxml/SCXMLExecutor.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/branches/J6/src/main/java/org/apache/commons/scxml/SCXMLExecutor.java?rev=653899&r1=653898&r2=653899&view=diff
==============================================================================
--- commons/proper/scxml/branches/J6/src/main/java/org/apache/commons/scxml/SCXMLExecutor.java (original)
+++ commons/proper/scxml/branches/J6/src/main/java/org/apache/commons/scxml/SCXMLExecutor.java Tue May  6 13:07:06 2008
@@ -310,6 +310,13 @@
 
     /**
      * Get the state machine that is being executed.
+     * <b>NOTE:</b> This is the state machine definition or model used by this
+     * executor instance. It may be shared across multiple executor instances
+     * and as a best practice, should not be altered. Also note that
+     * manipulation of instance data for the executor should happen through
+     * its root context or state contexts only, never through the direct
+     * manipulation of any {@link Datamodel}s associated with this state
+     * machine definition.
      *
      * @return Returns the stateMachine.
      */