Author: mduerig
Date: Wed Nov 25 16:29:17 2015
New Revision: 1716473
URL: http://svn.apache.org/viewvc?rev=1716473&view=rev
Log:
OAK-1828: Improved SegmentWriter
Some JavaDoc
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentBuilder.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentWriter.java
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentBuilder.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentBuilder.java?rev=1716473&r1=1716472&r2=1716473&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentBuilder.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentBuilder.java
Wed Nov 25 16:29:17 2015
@@ -46,7 +46,20 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * TODO document: not thread safe!
+ * This class encapsulates the state of a segment being written. It provides
methods
+ * for writing primitive data types and for pre-allocating buffer space in the
current
+ * segment. Should the current segment not have enough space left the current
segment
+ * is flushed and a fresh one is allocated.
+ * <p>
+ * The common usage pattern is:
+ * <pre>
+ * SegmentBuilder builder = ...
+ * builder.prepare(...) // allocate buffer
+ * builder.writeXYZ(...)
+ * </pre>
+ * The behaviour of this class is undefined should the pre-allocated buffer be
+ * overrun be calling any of the write methods.
+ *
* TODO find a better name for SegmentBuilder
*/
class SegmentBuilder {
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentWriter.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentWriter.java?rev=1716473&r1=1716472&r2=1716473&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentWriter.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentWriter.java
Wed Nov 25 16:29:17 2015
@@ -81,11 +81,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Converts nodes, properties, and values to records, which are written to a
- * byte array, in order to create segments.
- * <p>
- * The same writer is used to create multiple segments (data is automatically
- * split: new segments are automatically created if and when needed).
+ * Converts nodes, properties, and values to records, which are written to
segments.
*/
public class SegmentWriter {
private static final Logger LOG =
LoggerFactory.getLogger(SegmentWriter.class);
