Mailing-List: contact oak-commits-help@jackrabbit.apache.org; run by ezmlm
Precedence: bulk
Reply-To: oak-dev@jackrabbit.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1381598 -
 /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/Root.java
Date: Thu, 06 Sep 2012 13:41:39 -0000
To: oak-commits@jackrabbit.apache.org
From: mreutegg@apache.org
Message-Id: <20120906134139.45158238890D@eris.apache.org>

Author: mreutegg
Date: Thu Sep  6 13:41:38 2012
New Revision: 1381598

URL: http://svn.apache.org/viewvc?rev=1381598&view=rev
Log:
OAK-291: Clarify paths in Root

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/Root.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/Root.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/Root.java?rev=1381598&r1=1381597&r2=1381598&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/Root.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/Root.java Thu Sep  6 13:41:38 2012
@@ -28,7 +28,8 @@ public interface Root {
 
     /**
      * Move the child located at {@code sourcePath} to a child at {@code destPath}.
-     * Both paths must resolve to a child located beneath this root.<br>
+     * Both paths must be absolute and resolve to a child located beneath this
+     * root.<br>
      *
      * This method does nothing and returns {@code false} if
      * <ul>
@@ -40,15 +41,15 @@ public interface Root {
      * editing content session this method succeeds but a subsequent
      * {@link #commit(ConflictHandler)} will detect the violation and fail.
      *
-     * @param sourcePath The source path relative to this root
-     * @param destPath The destination path relative to this root
+     * @param sourcePath The source path
+     * @param destPath The destination path
      * @return {@code true} on success, {@code false} otherwise.
      */
     boolean move(String sourcePath, String destPath);
 
     /**
      * Copy the child located at {@code sourcePath} to a child at {@code destPath}.
-     * Both paths must resolve to a child located in this root.<br>
+     * Both paths must be absolute and resolve to a child located in this root.<br>
      *
      * This method does nothing an returns {@code false} if
      * <ul>
@@ -60,27 +61,28 @@ public interface Root {
      * editing content session this method succeeds but a subsequent
      * {@link #commit(ConflictHandler)} will detect the violation and fail.
      *
-     * @param sourcePath source path relative to this root
-     * @param destPath destination path relative to this root
+     * @param sourcePath source path
+     * @param destPath destination path
      * @return  {@code true} on success, {@code false} otherwise.
      */
     boolean copy(String sourcePath, String destPath);
 
     /**
-     * Retrieve the {@code Tree} at the given {@code path}. The path must resolve to
-     * a tree in this root.
+     * Retrieve the {@code Tree} at the given absolute {@code path}. The path
+     * must resolve to a tree in this root.
      *
-     * @param path  path to the tree
+     * @param path absolute path to the tree
      * @return tree at the given path or {@code null} if no such tree exists or
-     * if the tree at {@code path} is not accessible.
+     *         if the tree at {@code path} is not accessible.
      */
     @CheckForNull
     Tree getTree(String path);
 
     /**
-     * Get a tree location for a given {@code path}
-     * @param path  path to the location
-     * @return  the tree location for {@code path}
+     * Get a tree location for a given absolute {@code path}
+     *
+     * @param path absolute path to the location
+     * @return the tree location for {@code path}
      */
     @Nonnull
     TreeLocation getLocation(String path);