HBASE-7725: Add ability to create custom compaction request - ADDENDUM: fix javadocs

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1448778 13f79535-47bb-0310-9956-ffa450edef68

hbase-server/src/main/java/org/apache/hadoop/hbase/coprocessor/RegionObserver.java

@@ -148,8 +148,10 @@ public interface RegionObserver extends Coprocessor {
    * @param store the store where compaction is being requested
    * @param candidates the store files currently available for compaction
    * @throws IOException if an error occurred on the coprocessor
-   * @deprecated Use {@link #preCompactSelection(ObserverContext, Store, List, Object)} instead
+   * @deprecated Use {@link #preCompactSelection(ObserverContext, Store, List, CompactionRequest)}
+   *             instead
    */
+  @Deprecated
   void preCompactSelection(final ObserverContext<RegionCoprocessorEnvironment> c,
       final Store store, final List<StoreFile> candidates) throws IOException;
 
@@ -170,9 +172,8 @@ public interface RegionObserver extends Coprocessor {
    * @param c the environment provided by the region server
    * @param store the store being compacted
    * @param selected the store files selected to compact
-   * @param compactionAttributes custom attributes for the compaction
+   * @deprecated use {@link #postCompactSelection(ObserverContext, Store, ImmutableList,
-   * @deprecated use {@link #postCompactSelection(ObserverContext, Store, ImmutableList, Object)}
+   *             CompactionRequest)} instead.
-   *             instead.
    */
   @Deprecated
   void postCompactSelection(final ObserverContext<RegionCoprocessorEnvironment> c,
@@ -221,13 +222,12 @@ public interface RegionObserver extends Coprocessor {
    * @param store the store being compacted
    * @param scanner the scanner over existing data used in the store file rewriting
    * @param scanType type of Scan
-   * @param request the requested compaction
    * @return the scanner to use during compaction. Should not be {@code null} unless the
    *         implementation is writing new store files on its own.
    * @throws IOException if an error occurred on the coprocessor
    * @deprecated use
-   *             {@link #preCompact(ObserverContext, Store, InternalScanner, ScanType, CompactionRequest)}
+   *             {@link #preCompact(ObserverContext, Store, InternalScanner,
-   *             instead
+   *             ScanType, CompactionRequest)} instead
    */
   @Deprecated
   InternalScanner preCompact(final ObserverContext<RegionCoprocessorEnvironment> c,
@@ -271,13 +271,12 @@ public interface RegionObserver extends Coprocessor {
    * @param earliestPutTs timestamp of the earliest put that was found in any of the involved store
    *          files
    * @param s the base scanner, if not {@code null}, from previous RegionObserver in the chain
-   * @param request the requested compaction
    * @return the scanner to use during compaction. {@code null} if the default implementation is to
    *         be used.
    * @throws IOException if an error occurred on the coprocessor
    * @deprecated Use
-   *             {@link #preCompactScannerOpen(ObserverContext, Store, List, ScanType, long, InternalScanner, CompactionRequest)}
+   *             {@link #preCompactScannerOpen(ObserverContext, Store, List, ScanType, long,
-   *             instead.
+   *             InternalScanner, CompactionRequest)} instead.
    */
   @Deprecated
   InternalScanner preCompactScannerOpen(final ObserverContext<RegionCoprocessorEnvironment> c,

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/Compactor.java

@@ -18,7 +18,6 @@
 package org.apache.hadoop.hbase.regionserver.compactions;
 
 import java.io.IOException;
-import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 
@@ -42,7 +41,6 @@ public abstract class Compactor {
 
   /**
    * Do a minor/major compaction on an explicit set of storefiles from a Store.
-   * @param filesToCompact which files to compact
    * @param request the requested compaction
    * @return Product of compaction or an empty list if all cells expired or deleted and nothing made
    *         it through the compaction.

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/DefaultCompactor.java

@@ -44,8 +44,7 @@ import org.apache.hadoop.hbase.util.Bytes;
 import org.apache.hadoop.util.StringUtils;
 
 /**
- * Compact passed set of files.
+ * Compact passed set of files. Create an instance and then call {@link #compact(CompactionRequest)}
- * Create an instance and then call {@link #compact(Collection, boolean)}.
  */
 @InterfaceAudience.Private
 public class DefaultCompactor extends Compactor {