svn commit: r1746694 - in /jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment: RecordWriters.java SegmentNodeState.java

[md...@apache.org]

Author: mduerig
Date: Fri Jun  3 09:21:29 2016
New Revision: 1746694

URL: http://svn.apache.org/viewvc?rev=1746694&view=rev
Log:
@Trivial: inline comments

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

Modified: jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/RecordWriters.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/RecordWriters.java?rev=1746694&r1=1746693&r2=1746694&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/RecordWriters.java (original)
+++ jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/RecordWriters.java Fri Jun  3 09:21:29 2016
@@ -497,6 +497,8 @@ final class RecordWriters {
         @Override
         protected RecordId writeRecordContent(RecordId id, SegmentBufferWriter writer) {
             if (stableId == null) {
+                // Write this node's record id to indicate that the stable id is not
+                // explicitly stored.
                 writer.writeRecordId(id);
             } else {
                 writer.writeRecordId(stableId);

Modified: jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentNodeState.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentNodeState.java?rev=1746694&r1=1746693&r2=1746694&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentNodeState.java (original)
+++ jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentNodeState.java Fri Jun  3 09:21:29 2016
@@ -117,10 +117,16 @@ public class SegmentNodeState extends Re
      * @return  stable id
      */
     String getStableId() {
+        // The first record id of this node points to the stable id.
         RecordId id = getSegment().readRecordId(getOffset());
         if (id.equals(getRecordId())) {
+            // If that id is equal to the record id of this node then the stable
+            // id is the string representation of the record id of this node.
+            // See RecordWriters.NodeStateWriter.writeRecordContent()
             return id.toString10();
         } else {
+            // Otherwise that id points to the serialised (msb, lsb, offset)
+            // stable id.
             Segment segment = id.getSegment();
             int pos = id.getOffset();
             long msb = segment.readLong(pos);