fixed some javadoc warnings 134/head
authorKeith Turner <kturner@apache.org>
Mon, 12 Jun 2017 21:41:55 +0000 (17:41 -0400)
committerKeith Turner <kturner@apache.org>
Mon, 12 Jun 2017 21:42:17 +0000 (17:42 -0400)
.travis.yml
modules/accumulo/src/main/java/org/apache/fluo/recipes/accumulo/export/AccumuloExporter.java
modules/accumulo/src/main/java/org/apache/fluo/recipes/accumulo/export/AccumuloReplicator.java
modules/accumulo/src/main/java/org/apache/fluo/recipes/accumulo/export/function/AccumuloExporter.java
modules/core/src/main/java/org/apache/fluo/recipes/core/export/Exporter.java
modules/core/src/main/java/org/apache/fluo/recipes/core/export/function/Exporter.java

index 9c48f7a..3640303 100644 (file)
@@ -14,7 +14,7 @@
 language: java
 jdk:
   - oraclejdk8
-script: mvn -U verify
+script: mvn -U verify javadoc:jar
 sudo: false
 cache:
   directories:
index b2bef84..5fbef06 100644 (file)
@@ -24,8 +24,8 @@ import org.apache.fluo.api.config.FluoConfiguration;
 import org.apache.fluo.api.config.SimpleConfiguration;
 import org.apache.fluo.api.data.Bytes;
 import org.apache.fluo.api.data.RowColumn;
-import org.apache.fluo.recipes.core.export.ExportQueue.Options;
 import org.apache.fluo.recipes.accumulo.export.function.AccumuloTranslator;
+import org.apache.fluo.recipes.core.export.ExportQueue.Options;
 import org.apache.fluo.recipes.core.export.Exporter;
 import org.apache.fluo.recipes.core.export.SequencedExport;
 
@@ -88,7 +88,7 @@ public abstract class AccumuloExporter<K, V> extends Exporter<K, V> {
   /**
    * Implementations of this method should translate the given SequencedExport to 0 or more
    * Mutations.
-   * 
+   *
    * @param export the input that should be translated to mutations
    * @param consumer output mutations to this consumer
    */
@@ -116,6 +116,7 @@ public abstract class AccumuloExporter<K, V> extends Exporter<K, V> {
    * @deprecated since 1.1.0 use
    *             {@link AccumuloTranslator#generateMutations(long, Map, Map, Consumer)}
    */
+  @Deprecated
   public static void generateMutations(long seq, Map<RowColumn, Bytes> oldData,
       Map<RowColumn, Bytes> newData, Consumer<Mutation> consumer) {
     AccumuloTranslator.generateMutations(seq, oldData, newData, consumer);
index c2b9ade..35567fe 100644 (file)
@@ -24,7 +24,6 @@ import org.apache.accumulo.core.data.Mutation;
 import org.apache.accumulo.core.security.ColumnVisibility;
 import org.apache.fluo.api.data.Bytes;
 import org.apache.fluo.api.data.Column;
-import org.apache.fluo.recipes.accumulo.export.AccumuloExporter;
 import org.apache.fluo.recipes.accumulo.export.function.AccumuloTranslator;
 import org.apache.fluo.recipes.core.export.SequencedExport;
 import org.apache.fluo.recipes.core.transaction.LogEntry;
@@ -44,6 +43,7 @@ public class AccumuloReplicator extends AccumuloExporter<String, TxLog> {
    *             {@link org.apache.fluo.recipes.accumulo.export.function.AccumuloExporter} with
    *             {@link #getTranslator()} instead.
    */
+  @Deprecated
   @Override
   protected void translate(SequencedExport<String, TxLog> export, Consumer<Mutation> consumer) {
     generateMutations(export.getSequence(), export.getValue(), consumer);
@@ -51,7 +51,7 @@ public class AccumuloReplicator extends AccumuloExporter<String, TxLog> {
 
   /**
    * Returns LogEntry filter for Accumulo replication.
-   * 
+   *
    * @see RecordingTransaction#wrap(org.apache.fluo.api.client.TransactionBase, Predicate)
    */
   public static Predicate<LogEntry> getFilter() {
index 039dc55..1da0560 100644 (file)
@@ -22,16 +22,16 @@ import java.util.function.Consumer;
 import org.apache.accumulo.core.data.Mutation;
 import org.apache.fluo.api.config.FluoConfiguration;
 import org.apache.fluo.api.config.SimpleConfiguration;
+import org.apache.fluo.api.observer.ObserverProvider;
 import org.apache.fluo.recipes.core.export.ExportQueue;
 import org.apache.fluo.recipes.core.export.SequencedExport;
 import org.apache.fluo.recipes.core.export.function.Exporter;
-import org.apache.fluo.api.observer.ObserverProvider.Registry;
 
 /**
  * An Accumulo-specific {@link Exporter} that writes mutations to Accumulo. For an overview of how
  * to use this, see the project level documentation for exporting to Accumulo.
- * 
- * @see ExportQueue#registerObserver(Registry, Exporter)
+ *
+ * @see ExportQueue#registerObserver(ObserverProvider.Registry, Exporter)
  * @since 1.1.0
  */
 public class AccumuloExporter<K, V> implements Exporter<K, V> {
@@ -41,7 +41,7 @@ public class AccumuloExporter<K, V> implements Exporter<K, V> {
 
   /**
    * Part of a fluent configuration API.
-   * 
+   *
    * @since 1.1.0
    */
   public static interface InstanceArgs {
@@ -50,7 +50,7 @@ public class AccumuloExporter<K, V> implements Exporter<K, V> {
 
   /**
    * Part of a fluent configuration API.
-   * 
+   *
    * @since 1.1.0
    */
   public static interface CredentialArgs {
@@ -59,7 +59,7 @@ public class AccumuloExporter<K, V> implements Exporter<K, V> {
 
   /**
    * Part of a fluent configuration API.
-   * 
+   *
    * @since 1.1.0
    */
   public static interface TableArgs {
@@ -68,7 +68,7 @@ public class AccumuloExporter<K, V> implements Exporter<K, V> {
 
   /**
    * Part of a fluent configuration API.
-   * 
+   *
    * @since 1.1.0
    */
   public static interface Options {
index 91802d6..de8739d 100644 (file)
@@ -19,13 +19,10 @@ import java.util.Iterator;
 
 import org.apache.fluo.api.config.SimpleConfiguration;
 import org.apache.fluo.api.observer.Observer;
-import org.apache.fluo.api.observer.ObserverProvider.Registry;
 
 /**
  * @since 1.0.0
- * @deprecated since 1.1.0 replaced by
- *             {@link ExportQueue#registerObserver(Registry, org.apache.fluo.recipes.core.export.function.Exporter)}
- *             and {@link org.apache.fluo.recipes.core.export.function.Exporter}
+ * @deprecated since 1.1.0 replaced by {@link org.apache.fluo.recipes.core.export.function.Exporter}
  */
 @Deprecated
 public abstract class Exporter<K, V> {
index e6c14d5..9e95560 100644 (file)
@@ -18,6 +18,7 @@ package org.apache.fluo.recipes.core.export.function;
 import java.util.Iterator;
 import java.util.Objects;
 
+import org.apache.fluo.recipes.core.export.ExportQueue;
 import org.apache.fluo.recipes.core.export.SequencedExport;
 
 /**
@@ -55,6 +56,8 @@ import org.apache.fluo.recipes.core.export.SequencedExport;
  * </ul>
  *
  * @since 1.1.0
+ * @see ExportQueue#registerObserver(org.apache.fluo.api.observer.ObserverProvider.Registry,
+ *      Exporter)
  */
 @FunctionalInterface
 public interface Exporter<K, V> {
@@ -62,7 +65,7 @@ public interface Exporter<K, V> {
   /**
    * Performs this export operation.
    *
-   * @param t the input argument
+   * @param exports an iterator over the data to export
    */
   void export(Iterator<SequencedExport<K, V>> exports);