svn commit: r1566811 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitInfo.java

[ju...@apache.org]

Author: jukka
Date: Mon Feb 10 23:02:58 2014
New Revision: 1566811

URL: http://svn.apache.org/r1566811
Log:
OAK-1387: Pass CommitInfo to commit hooks, editors and validators

Add javadocs to CommitInfo.getPath()

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitInfo.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitInfo.java?rev=1566811&r1=1566810&r2=1566811&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitInfo.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitInfo.java Mon Feb 10 23:02:58 2014
@@ -104,6 +104,17 @@ public final class CommitInfo {
         return date;
     }
 
+    /**
+     * Returns the base path of this commit. All changes within this commit
+     * are expected to be located within the returned path. By default this
+     * is the root path, but a particular commit can declare a more specific
+     * base path to indicate that only changes within that subtree should
+     * be considered. Note that this value is purely informational and its
+     * interpretation depends on the kinds of commit hooks and observers
+     * present on the system.
+     *
+     * @return base path of this commit
+     */
     public String getPath() {
         return path;
     }