jackrabbit-oak-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject svn commit: r1372850 - /jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java
Date Tue, 14 Aug 2012 11:53:34 GMT
Author: stefan
Date: Tue Aug 14 11:53:34 2012
New Revision: 1372850

URL: http://svn.apache.org/viewvc?rev=1372850&view=rev
Log:
OAK-239: MicroKernel.getRevisionHistory: maxEntries behavior should be documented

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=1372850&r1=1372849&r2=1372850&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 Aug 14 11:53:34 2012
@@ -98,6 +98,12 @@ public interface MicroKernel {
      * The {@code path} parameter allows to filter the revisions by path, i.e.
      * only those revisions that affected the subtree rooted at {@code path}
      * will be included.
+     * <p/>
+     * The {@code maxEntries} parameter allows to limit the number of revisions
+     * returned. if {@code maxEntries < 0} no limit will be applied. otherwise,
+     * if the number of revisions satisfying the specified {@code since} and
+     * {@code path} criteria exceeds {@code maxEntries}, only {@code maxEntries}
+     * entries will be returned (in chronological order, starting with the oldest).
      *
      * @param since      timestamp (ms) of earliest revision to be returned
      * @param maxEntries maximum #entries to be returned;



Mime
View raw message