svn commit: r1763137 - /jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/Segment.java

[fr...@apache.org]

Author: frm
Date: Mon Oct  3 09:17:00 2016
New Revision: 1763137

URL: http://svn.apache.org/viewvc?rev=1763137&view=rev
Log:
OAK-2498 - Add documentation for Segment.forEachRecord()

Modified:
    jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/Segment.java

Modified: jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/Segment.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/Segment.java?rev=1763137&r1=1763136&r2=1763137&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/Segment.java (original)
+++ jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/Segment.java Mon Oct  3 09:17:00 2016
@@ -639,12 +639,27 @@ public class Segment {
         }
     }
 
+    /**
+     * A consumer of record data.
+     */
     public interface RecordConsumer {
 
+        /**
+         * Consume data about a record.
+         *
+         * @param number the record number.
+         * @param type   the record type.
+         * @param offset the offset where the record is stored.
+         */
         void consume(int number, RecordType type, int offset);
 
     }
 
+    /**
+     * Iterate over the records contained in this segment.
+     *
+     * @param consumer an instance of {@link RecordConsumer}.
+     */
     public void forEachRecord(RecordConsumer consumer) {
         for (Entry entry : recordNumbers) {
             consumer.consume(entry.getRecordNumber(), entry.getType(), entry.getOffset());