svn commit: r13947 - trunk/src/model/src/org/argouml/model/ModelManagementHelper.java

Author: tfmorris
Date: 2007-12-18 09:29:52-0800
New Revision: 13947

Modified:
   trunk/src/model/src/org/argouml/model/ModelManagementHelper.java

Log:
Update Javadoc for getPath.  No functional changes.

Modified: trunk/src/model/src/org/argouml/model/ModelManagementHelper.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/model/src/org/argouml/model/ModelManagementHelper.java?view=diff&rev=13947&p1=trunk/src/model/src/org/argouml/model/ModelManagementHelper.java&p2=trunk/src/model/src/org/argouml/model/ModelManagementHelper.java&r1=13946&r2=13947
==============================================================================
--- trunk/src/model/src/org/argouml/model/ModelManagementHelper.java	(original)
+++ trunk/src/model/src/org/argouml/model/ModelManagementHelper.java	2007-12-18 09:29:52-0800
@@ -134,7 +134,8 @@
      * Get the modelelement a given path below a given root-namespace.
      *
      * @param path the given path
-     * @param theRootNamespace the given namespace to start from
+     * @param theRootNamespace the given namespace to start from.  If null, start
+     * from the root (equivalent to {@link #getElement(List)}.
      * @return the modelelement looked for, or null if not found
      */
     Object getElement(List<String> path, Object theRootNamespace);
@@ -143,11 +144,16 @@
      * Finds the absolute path of a ModelElement. Ie the name of each namespace
      * starting at the root (the Model) and ending with the name of the element.
      * <p>
-     * The returned Vector implicitly starts at the root (the model) and follows
-     * element's chain of owning namespaces back down to element. The first
-     * element will thus be the name of the top level namespace below the model,
-     * and the last element will be the name of element itself. Note thus that
-     * for the model the path will be empty.
+     * The returned Vector implicitly starts at the <em>innermost</em>
+     * containing model and follows element's chain of owning namespaces back
+     * down to element. The first element will thus be the name of the namespace
+     * contained the Model, and the last element will be the name of element
+     * itself. Note thus that for the model the path will be empty.
+     * <p>
+     * <em>NOTE:</em>In the case of nested Models (ie a top level UML Model
+     * that contains other UML Models, this may not produce the expected
+     * results, but the historical behavior has been retained for backward
+     * compatibility. All new code should use {@link #getPathList(Object)}.
      * 
      * @deprecated for 0.25.4 by tfmorris. Use {@link #getPathList(Object)} but
      *             be aware that the implementations are not 100% compatible.