You are viewing a plain text version of this content. The canonical link for it is here.

Posted to oak-commits@jackrabbit.apache.org by ju...@apache.org on 2013/11/11 17:56:27 UTC

svn commit: r1540774 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/NodeState.java

Author: jukka
Date: Mon Nov 11 16:56:27 2013
New Revision: 1540774

URL: http://svn.apache.org/r1540774
Log:
OAK-1148: Incomplete Javadoc with NodeState#compareAgainstBaseState

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/NodeState.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/NodeState.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/NodeState.java?rev=1540774&r1=1540773&r2=1540774&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/NodeState.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/NodeState.java Mon Nov 11 16:56:27 2013
@@ -347,6 +347,9 @@ public interface NodeState {
      *
      * @param base base state
      * @param diff handler of node state differences
+     * @return {@code true} if the full diff was performed, or
+     *         {@code false} if it was aborted as requested by the handler
+     *         (see the {@link NodeStateDiff} contract for more details)
      * @since 0ak 0.4, return value added in 0.7
      */
     boolean compareAgainstBaseState(NodeState base, NodeStateDiff diff);