jackrabbit-oak-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mdue...@apache.org
Subject svn commit: r1373892 - /jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/SessionDelegate.java
Date Thu, 16 Aug 2012 15:56:40 GMT
Author: mduerig
Date: Thu Aug 16 15:56:40 2012
New Revision: 1373892

URL: http://svn.apache.org/viewvc?rev=1373892&view=rev
Log:
OAK-230: Review and fix inconsistent usage of oak-path in oak-jcr
 Javadoc clarifying paths

Modified:
    jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/SessionDelegate.java

Modified: jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/SessionDelegate.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/SessionDelegate.java?rev=1373892&r1=1373891&r2=1373892&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/SessionDelegate.java
(original)
+++ jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/SessionDelegate.java
Thu Aug 16 15:56:40 2012
@@ -175,6 +175,12 @@ public class SessionDelegate {
         }
     }
 
+    /**
+     * {@code NodeDelegate} at the given path
+     * @param path Oak path
+     * @return  The {@code NodeDelegate} at {@code path} or {@code null} if
+     * none exists or not accessible.
+     */
     @CheckForNull
     public NodeDelegate getNode(String path) {
         Tree tree = getTree(path);
@@ -320,6 +326,12 @@ public class SessionDelegate {
         return contentSession.getWorkspaceName();
     }
 
+    /**
+     * Copy a node
+     * @param srcPath  oak path to the source node to copy
+     * @param destPath  oak path to the destination
+     * @throws RepositoryException
+     */
     public void copy(String srcPath, String destPath) throws RepositoryException {
         // check destination
         Tree dest = getTree(destPath);
@@ -350,6 +362,13 @@ public class SessionDelegate {
         }
     }
 
+    /**
+     * Move a node
+     * @param srcPath  oak path to the source node to copy
+     * @param destPath  oak path to the destination
+     * @param transientOp  whether or not to perform the move in transient space
+     * @throws RepositoryException
+     */
     public void move(String srcPath, String destPath, boolean transientOp)
             throws RepositoryException {
 
@@ -429,6 +448,12 @@ public class SessionDelegate {
 
     //-----------------------------------------------------------< internal >---
 
+    /**
+     * Get the {@code Tree} with the given path
+     * @param path  oak path
+     * @return  tree at the given path or {@code null} if no such tree exists or
+     * if the tree at {@code path} is not accessible.
+     */
     @CheckForNull
     Tree getTree(String path) {
         return root.getTree(path);



Mime
View raw message