You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by md...@apache.org on 2017/08/11 10:04:02 UTC

svn commit: r1804760 - /jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/compaction/SegmentGCOptions.java

Author: mduerig
Date: Fri Aug 11 10:04:02 2017
New Revision: 1804760

URL: http://svn.apache.org/viewvc?rev=1804760&view=rev
Log:
OAK-6549: Move gcType to SegmentGCOptions
Javadoc

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

Modified: jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/compaction/SegmentGCOptions.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/compaction/SegmentGCOptions.java?rev=1804760&r1=1804759&r2=1804760&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/compaction/SegmentGCOptions.java (original)
+++ jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/compaction/SegmentGCOptions.java Fri Aug 11 10:04:02 2017
@@ -30,9 +30,20 @@ import org.apache.jackrabbit.oak.segment
  */
 public class SegmentGCOptions {
 
-    // michid doc
+    /**
+     * The gc type.
+     */
     public enum GCType {
+
+        /**
+         * Full gc: compaction will compact the full head state.
+         */
         FULL,
+
+        /**
+         * Tail gc: compaction will compact the diff between the head state created by
+         * the previous compaction run and the current head state.
+         */
         TAIL
     }
 
@@ -217,13 +228,18 @@ public class SegmentGCOptions {
         return this;
     }
 
-    // michid doc
+    /**
+     * @return the currently set gc type.
+     */
     @Nonnull
     public GCType getGCType() {
         return gcType;
     }
 
-    // michid doc
+    /**
+     * Set the gc type.
+     * @param gcType  the type of gc to run.
+     */
     public void setGCType(@Nonnull GCType gcType) {
         this.gcType = gcType;
     }