svn commit: r1359679 - /jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java

[st...@apache.org]

Author: stefan
Date: Tue Jul 10 14:04:54 2012
New Revision: 1359679

URL: http://svn.apache.org/viewvc?rev=1359679&view=rev
Log:
OAK-11 Document and tighten contract of Microkernel API

state child node order as returned by getNodes() more precisely

Modified:
    jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java

Modified: jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java?rev=1359679&r1=1359678&r2=1359679&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java (original)
+++ jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java Tue Jul 10 14:04:54 2012
@@ -286,6 +286,12 @@ public interface MicroKernel {
      * greater than zero and a {@code filter} on node names (see below) have been
      * specified.
      * <p/>
+     * The order of the child nodes is stable for any given {@code revisionId},
+     * i.e. calling {@link #getNodes} repeatedly with the same {@code revisionId}
+     * is guaranteed to return the child nodes in the same order, but the
+     * specific order used is implementation-dependent and may change across
+     * different revisions of the same node.
+     * <p/>
      * The optional {@code filter} parameter allows to specify glob patterns for names of
      * nodes and/or properties to be included or excluded.
      * <p/>