svn commit: r1373876 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/namepath/PathMapper.java

[md...@apache.org]

Author: mduerig
Date: Thu Aug 16 15:09:50 2012
New Revision: 1373876

URL: http://svn.apache.org/viewvc?rev=1373876&view=rev
Log:
OAK-221: Clarify nature of 'path' parameter in oak-api
 specify syntax of Oak paths

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/namepath/PathMapper.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/namepath/PathMapper.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/namepath/PathMapper.java?rev=1373876&r1=1373875&r2=1373876&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/namepath/PathMapper.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/namepath/PathMapper.java Thu Aug 16 15:09:50 2012
@@ -22,6 +22,11 @@ import javax.annotation.Nonnull;
 /**
  * {@code PathMapper} instances provide methods for mapping paths from their JCR
  * string representation to their Oak representation and vice versa.
+ *
+ * The Oak representation of a path consists of an optional forward slash followed
+ * by the names of the respective items in the
+ * {@link org.apache.jackrabbit.oak.api.Tree} separated by forward slashes.
+ * FIXME make leading forward slash not optional. See OAK-221
  */
 public interface PathMapper {