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

[md...@apache.org]

Author: mduerig
Date: Mon May 23 15:55:31 2016
New Revision: 1745223

URL: http://svn.apache.org/viewvc?rev=1745223&view=rev
Log:
OAK-4373: Refactor SegmentTracker
Javadoc for SegmentTracker

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

Modified: jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentTracker.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentTracker.java?rev=1745223&r1=1745222&r2=1745223&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentTracker.java (original)
+++ jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentTracker.java Mon May 23 15:55:31 2016
@@ -32,9 +32,8 @@ import org.slf4j.LoggerFactory;
 
 /**
  * Tracker of references to segment identifiers and segment instances
- * that are currently kept in memory.
- * <p>
- * It is also responsible to cache segment objects in memory.
+ * that are currently kept in memory and factory for creating {@link SegmentId}
+ * instances.
  */
 public class SegmentTracker {
     private static final Logger log = LoggerFactory.getLogger(SegmentTracker.class);
@@ -101,9 +100,10 @@ public class SegmentTracker {
     }
 
     /**
-     * 
-     * @param msb
-     * @param lsb
+     * Get an existing {@code SegmentId} with the given {@code msb} and {@code lsb}
+     * or create a new one if no such id exists with this tracker.
+     * @param msb  most significant bits of the segment id
+     * @param lsb  least  significant bits of the segment id
      * @return the segment id
      */
     public SegmentId getSegmentId(long msb, long lsb) {
@@ -111,10 +111,18 @@ public class SegmentTracker {
         return tables[index].getSegmentId(msb, lsb);
     }
 
+    /**
+     * Create and track a new segment id for data segments.
+     * @return the segment id
+     */
     SegmentId newDataSegmentId() {
         return newSegmentId(DATA);
     }
 
+    /**
+     * Create and track a new segment id for bulk segments.
+     * @return the segment id
+     */
     SegmentId newBulkSegmentId() {
         return newSegmentId(BULK);
     }