You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fluo.apache.org by kt...@apache.org on 2016/07/20 16:59:06 UTC

incubator-fluo-recipes git commit: Minor updates in preparation for 1.0.0 release

Repository: incubator-fluo-recipes
Updated Branches:
  refs/heads/master b4c9cdce8 -> 3ee377194


Minor updates in preparation for 1.0.0 release

* Set version to 1.0.0-incubating-SNAPSHOT
* Removed unnecessary whitespace
* Added missing @since tags
* Excluded *.impl.* packages from javadocs
* Removed unnecessary public modifiers from public interface methods
* Fixed method misspelling in SimpleSerializer
* Set Accumulo min version in pom.xml to 1.6.5 to match Fluo


Project: http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/commit/3ee37719
Tree: http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/tree/3ee37719
Diff: http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/diff/3ee37719

Branch: refs/heads/master
Commit: 3ee377194f54d62cb2cdce8fc7ad237815edee5e
Parents: b4c9cdc
Author: Mike Walch <mw...@gmail.com>
Authored: Mon Jul 18 16:42:30 2016 -0400
Committer: Mike Walch <mw...@gmail.com>
Committed: Mon Jul 18 16:49:26 2016 -0400

----------------------------------------------------------------------
 README.md                                             |  2 +-
 .../org/apache/fluo/recipes/core/common/RowRange.java |  1 -
 .../org/apache/fluo/recipes/core/data/RowHasher.java  |  1 -
 .../apache/fluo/recipes/core/export/ExportBucket.java |  1 -
 .../apache/fluo/recipes/core/export/ExportQueue.java  |  4 +++-
 .../fluo/recipes/core/map/CollisionFreeMap.java       |  5 +++++
 .../recipes/core/serialization/SimpleSerializer.java  | 14 +++++++-------
 .../fluo/recipes/core/transaction/LogEntry.java       |  3 +++
 .../fluo/recipes/core/export/ExportTestBase.java      |  2 +-
 .../org/apache/fluo/recipes/core/map/BigUpdateIT.java |  2 +-
 .../fluo/recipes/core/map/CollisionFreeMapIT.java     |  2 +-
 .../fluo/recipes/kryo/KryoSimplerSerializer.java      |  5 +++--
 .../fluo/recipes/spark/AccumuloRangePartitioner.java  |  1 -
 .../apache/fluo/recipes/spark/FluoSparkHelper.java    |  2 ++
 .../apache/fluo/recipes/spark/FluoSparkTestUtil.java  |  2 --
 .../fluo/recipes/test/AccumuloExportITBase.java       |  1 -
 .../org/apache/fluo/recipes/test/FluoITHelper.java    |  3 ---
 pom.xml                                               | 11 +++++++++--
 18 files changed, 36 insertions(+), 26 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 39ee2c4..024cb58 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ Below are Maven dependencies for Fluo Recipes.
 
 ```xml
   <properties>
-    <fluo-recipes.version>1.0.0-beta-2</fluo-recipes.version>
+    <fluo-recipes.version>1.0.0-incubating</fluo-recipes.version>
   </properties>
 
   <dependencies>

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/main/java/org/apache/fluo/recipes/core/common/RowRange.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/fluo/recipes/core/common/RowRange.java b/modules/core/src/main/java/org/apache/fluo/recipes/core/common/RowRange.java
index 361dd6e..7492432 100644
--- a/modules/core/src/main/java/org/apache/fluo/recipes/core/common/RowRange.java
+++ b/modules/core/src/main/java/org/apache/fluo/recipes/core/common/RowRange.java
@@ -71,7 +71,6 @@ public class RowRange {
     }
   }
 
-
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/main/java/org/apache/fluo/recipes/core/data/RowHasher.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/fluo/recipes/core/data/RowHasher.java b/modules/core/src/main/java/org/apache/fluo/recipes/core/data/RowHasher.java
index e40ce9b..3be8b27 100644
--- a/modules/core/src/main/java/org/apache/fluo/recipes/core/data/RowHasher.java
+++ b/modules/core/src/main/java/org/apache/fluo/recipes/core/data/RowHasher.java
@@ -69,7 +69,6 @@ public class RowHasher {
     return tableOptim;
   }
 
-
   private Bytes prefix;
 
   public RowHasher(String prefix) {

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportBucket.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportBucket.java b/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportBucket.java
index c0dae48..7c5c366 100644
--- a/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportBucket.java
+++ b/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportBucket.java
@@ -100,7 +100,6 @@ class ExportBucket {
         + ((seq.byteAt(6) & 255) << 8) + ((seq.byteAt(7) & 255) << 0));
   }
 
-
   public void add(long seq, byte[] key, byte[] value) {
     Bytes row =
         Bytes.newBuilder(bucketRow.length() + 1 + key.length + 8).append(bucketRow).append(":")

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportQueue.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportQueue.java b/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportQueue.java
index dffa713..e53e17c 100644
--- a/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportQueue.java
+++ b/modules/core/src/main/java/org/apache/fluo/recipes/core/export/ExportQueue.java
@@ -170,6 +170,9 @@ public class ExportQueue<K, V> {
     return tableOptim;
   }
 
+  /**
+   * @since 1.0.0
+   */
   public static class Options {
 
     private static final String PREFIX = "recipes.exportQueue.";
@@ -208,7 +211,6 @@ public class ExportQueue<K, V> {
       this.valueType = valueType;
     }
 
-
     public <K, V> Options(String queueId, Class<? extends Exporter<K, V>> exporter,
         Class<K> keyType, Class<V> valueType, int buckets) {
       this(queueId, exporter.getName(), keyType.getName(), valueType.getName(), buckets);

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/main/java/org/apache/fluo/recipes/core/map/CollisionFreeMap.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/fluo/recipes/core/map/CollisionFreeMap.java b/modules/core/src/main/java/org/apache/fluo/recipes/core/map/CollisionFreeMap.java
index ccb250f..4f57003 100644
--- a/modules/core/src/main/java/org/apache/fluo/recipes/core/map/CollisionFreeMap.java
+++ b/modules/core/src/main/java/org/apache/fluo/recipes/core/map/CollisionFreeMap.java
@@ -402,6 +402,8 @@ public class CollisionFreeMap<K, V> {
 
   /**
    * @see CollisionFreeMap#getInitializer(String, int, SimpleSerializer)
+   *
+   * @since 1.0.0
    */
   public static class Initializer<K2, V2> implements Serializable {
 
@@ -432,6 +434,9 @@ public class CollisionFreeMap<K, V> {
     }
   }
 
+  /**
+   * @since 1.0.0
+   */
   public static class Options {
 
     static final long DEFAULT_BUFFER_SIZE = 1 << 22;

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/main/java/org/apache/fluo/recipes/core/serialization/SimpleSerializer.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/fluo/recipes/core/serialization/SimpleSerializer.java b/modules/core/src/main/java/org/apache/fluo/recipes/core/serialization/SimpleSerializer.java
index 4efed5f..aad9437 100644
--- a/modules/core/src/main/java/org/apache/fluo/recipes/core/serialization/SimpleSerializer.java
+++ b/modules/core/src/main/java/org/apache/fluo/recipes/core/serialization/SimpleSerializer.java
@@ -26,23 +26,23 @@ public interface SimpleSerializer {
   /**
    * Called immediately after construction and passed Fluo application configuration.
    */
-  public void init(SimpleConfiguration appConfig);
+  void init(SimpleConfiguration appConfig);
 
   // TODO refactor to support reuse of objects and byte arrays???
-  public <T> byte[] serialize(T obj);
+  <T> byte[] serialize(T obj);
 
-  public <T> T deserialize(byte[] serObj, Class<T> clazz);
+  <T> T deserialize(byte[] serObj, Class<T> clazz);
 
-  public static void setSetserlializer(FluoConfiguration fluoConfig,
+  static void setSerializer(FluoConfiguration fluoConfig,
       Class<? extends SimpleSerializer> serializerType) {
-    setSetserlializer(fluoConfig, serializerType.getName());
+    setSerializer(fluoConfig, serializerType.getName());
   }
 
-  public static void setSetserlializer(FluoConfiguration fluoConfig, String serializerType) {
+  static void setSerializer(FluoConfiguration fluoConfig, String serializerType) {
     fluoConfig.getAppConfiguration().setProperty("recipes.serializer", serializerType);
   }
 
-  public static SimpleSerializer getInstance(SimpleConfiguration appConfig) {
+  static SimpleSerializer getInstance(SimpleConfiguration appConfig) {
     String serType =
         appConfig.getString("recipes.serializer",
             "org.apache.fluo.recipes.kryo.KryoSimplerSerializer");

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/main/java/org/apache/fluo/recipes/core/transaction/LogEntry.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/fluo/recipes/core/transaction/LogEntry.java b/modules/core/src/main/java/org/apache/fluo/recipes/core/transaction/LogEntry.java
index 6023e4a..9e61c4d 100644
--- a/modules/core/src/main/java/org/apache/fluo/recipes/core/transaction/LogEntry.java
+++ b/modules/core/src/main/java/org/apache/fluo/recipes/core/transaction/LogEntry.java
@@ -28,6 +28,9 @@ import org.apache.fluo.api.data.Column;
  */
 public class LogEntry {
 
+  /**
+   * @since 1.0.0
+   */
   public enum Operation {
     GET, SET, DELETE
   }

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/test/java/org/apache/fluo/recipes/core/export/ExportTestBase.java
----------------------------------------------------------------------
diff --git a/modules/core/src/test/java/org/apache/fluo/recipes/core/export/ExportTestBase.java b/modules/core/src/test/java/org/apache/fluo/recipes/core/export/ExportTestBase.java
index 4493fdf..d9e9034 100644
--- a/modules/core/src/test/java/org/apache/fluo/recipes/core/export/ExportTestBase.java
+++ b/modules/core/src/test/java/org/apache/fluo/recipes/core/export/ExportTestBase.java
@@ -144,7 +144,7 @@ public class ExportTestBase {
     ObserverConfiguration doc = new ObserverConfiguration(DocumentObserver.class.getName());
     props.addObserver(doc);
 
-    SimpleSerializer.setSetserlializer(props, GsonSerializer.class);
+    SimpleSerializer.setSerializer(props, GsonSerializer.class);
 
     ExportQueue.Options exportQueueOpts =
         new ExportQueue.Options(RefExporter.QUEUE_ID, RefExporter.class, String.class,

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/test/java/org/apache/fluo/recipes/core/map/BigUpdateIT.java
----------------------------------------------------------------------
diff --git a/modules/core/src/test/java/org/apache/fluo/recipes/core/map/BigUpdateIT.java b/modules/core/src/test/java/org/apache/fluo/recipes/core/map/BigUpdateIT.java
index 66056c6..3f3a84c 100644
--- a/modules/core/src/test/java/org/apache/fluo/recipes/core/map/BigUpdateIT.java
+++ b/modules/core/src/test/java/org/apache/fluo/recipes/core/map/BigUpdateIT.java
@@ -116,7 +116,7 @@ public class BigUpdateIT {
     props.setWorkerThreads(20);
     props.setMiniDataDir("target/mini");
 
-    SimpleSerializer.setSetserlializer(props, TestSerializer.class);
+    SimpleSerializer.setSerializer(props, TestSerializer.class);
 
     CollisionFreeMap.configure(props, new CollisionFreeMap.Options(MAP_ID, LongCombiner.class,
         MyObserver.class, String.class, Long.class, 2).setBufferSize(1 << 10));

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/core/src/test/java/org/apache/fluo/recipes/core/map/CollisionFreeMapIT.java
----------------------------------------------------------------------
diff --git a/modules/core/src/test/java/org/apache/fluo/recipes/core/map/CollisionFreeMapIT.java b/modules/core/src/test/java/org/apache/fluo/recipes/core/map/CollisionFreeMapIT.java
index cb76891..7e1ac21 100644
--- a/modules/core/src/test/java/org/apache/fluo/recipes/core/map/CollisionFreeMapIT.java
+++ b/modules/core/src/test/java/org/apache/fluo/recipes/core/map/CollisionFreeMapIT.java
@@ -59,7 +59,7 @@ public class CollisionFreeMapIT {
 
     props.addObserver(new ObserverConfiguration(DocumentObserver.class.getName()));
 
-    SimpleSerializer.setSetserlializer(props, TestSerializer.class);
+    SimpleSerializer.setSerializer(props, TestSerializer.class);
 
     CollisionFreeMap.configure(props, new CollisionFreeMap.Options(MAP_ID, WordCountCombiner.class,
         WordCountObserver.class, String.class, Long.class, 17));

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/kryo/src/main/java/org/apache/fluo/recipes/kryo/KryoSimplerSerializer.java
----------------------------------------------------------------------
diff --git a/modules/kryo/src/main/java/org/apache/fluo/recipes/kryo/KryoSimplerSerializer.java b/modules/kryo/src/main/java/org/apache/fluo/recipes/kryo/KryoSimplerSerializer.java
index 5c10d85..aff9e7c 100644
--- a/modules/kryo/src/main/java/org/apache/fluo/recipes/kryo/KryoSimplerSerializer.java
+++ b/modules/kryo/src/main/java/org/apache/fluo/recipes/kryo/KryoSimplerSerializer.java
@@ -64,6 +64,9 @@ public class KryoSimplerSerializer implements SimpleSerializer, Serializable {
     }
   }
 
+  /**
+   * @since 1.0.0
+   */
   public static class DefaultFactory implements KryoFactory {
     @Override
     public Kryo create() {
@@ -117,7 +120,6 @@ public class KryoSimplerSerializer implements SimpleSerializer, Serializable {
   /**
    * Call this to configure a KryoFactory type before initializing Fluo.
    */
-
   public static void setKryoFactory(FluoConfiguration config, String factoryType) {
     config.getAppConfiguration().setProperty(KRYO_FACTORY_PROP, factoryType);
   }
@@ -125,7 +127,6 @@ public class KryoSimplerSerializer implements SimpleSerializer, Serializable {
   /**
    * Call this to configure a KryoFactory type before initializing Fluo.
    */
-
   public static void setKryoFactory(FluoConfiguration config,
       Class<? extends KryoFactory> factoryType) {
     config.getAppConfiguration().setProperty(KRYO_FACTORY_PROP, factoryType.getName());

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/spark/src/main/java/org/apache/fluo/recipes/spark/AccumuloRangePartitioner.java
----------------------------------------------------------------------
diff --git a/modules/spark/src/main/java/org/apache/fluo/recipes/spark/AccumuloRangePartitioner.java b/modules/spark/src/main/java/org/apache/fluo/recipes/spark/AccumuloRangePartitioner.java
index 9e662e3..7bd544a 100644
--- a/modules/spark/src/main/java/org/apache/fluo/recipes/spark/AccumuloRangePartitioner.java
+++ b/modules/spark/src/main/java/org/apache/fluo/recipes/spark/AccumuloRangePartitioner.java
@@ -52,5 +52,4 @@ public class AccumuloRangePartitioner extends Partitioner {
   public int numPartitions() {
     return splits.size() + 1;
   }
-
 }

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkHelper.java
----------------------------------------------------------------------
diff --git a/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkHelper.java b/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkHelper.java
index e865888..a24aa48 100644
--- a/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkHelper.java
+++ b/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkHelper.java
@@ -250,6 +250,8 @@ public class FluoSparkHelper {
 
   /**
    * Optional settings for Bulk Imports
+   *
+   * @since 1.0.0
    */
   public static class BulkImportOptions {
 

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkTestUtil.java
----------------------------------------------------------------------
diff --git a/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkTestUtil.java b/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkTestUtil.java
index 163bb8f..ca852fd 100644
--- a/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkTestUtil.java
+++ b/modules/spark/src/main/java/org/apache/fluo/recipes/spark/FluoSparkTestUtil.java
@@ -18,7 +18,6 @@ package org.apache.fluo.recipes.spark;
 import org.apache.spark.SparkConf;
 import org.apache.spark.api.java.JavaSparkContext;
 
-
 /**
  * Utility code for Fluo/Spark testing
  *
@@ -40,5 +39,4 @@ public class FluoSparkTestUtil {
     sparkConf.set("spark.ui.port", "4444");
     return new JavaSparkContext(sparkConf);
   }
-
 }

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/test/src/main/java/org/apache/fluo/recipes/test/AccumuloExportITBase.java
----------------------------------------------------------------------
diff --git a/modules/test/src/main/java/org/apache/fluo/recipes/test/AccumuloExportITBase.java b/modules/test/src/main/java/org/apache/fluo/recipes/test/AccumuloExportITBase.java
index 00795f4..713d8c8 100644
--- a/modules/test/src/main/java/org/apache/fluo/recipes/test/AccumuloExportITBase.java
+++ b/modules/test/src/main/java/org/apache/fluo/recipes/test/AccumuloExportITBase.java
@@ -175,7 +175,6 @@ public class AccumuloExportITBase {
 
   }
 
-
   /**
    * This method is intended to be overridden. The method is called before each test after Fluo is
    * initialized before MiniFluo is started.

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/modules/test/src/main/java/org/apache/fluo/recipes/test/FluoITHelper.java
----------------------------------------------------------------------
diff --git a/modules/test/src/main/java/org/apache/fluo/recipes/test/FluoITHelper.java b/modules/test/src/main/java/org/apache/fluo/recipes/test/FluoITHelper.java
index ddc51ef..430811c 100644
--- a/modules/test/src/main/java/org/apache/fluo/recipes/test/FluoITHelper.java
+++ b/modules/test/src/main/java/org/apache/fluo/recipes/test/FluoITHelper.java
@@ -292,7 +292,6 @@ public class FluoITHelper {
    * A helper method for parsing test data. Each string passed in is split using the specified
    * splitter into four fields for row, family, qualifier, and value.
    */
-
   public static List<RowColumnValue> parse(Splitter splitter, String... data) {
     ArrayList<RowColumnValue> ret = new ArrayList<>();
 
@@ -312,6 +311,4 @@ public class FluoITHelper {
 
     return ret;
   }
-
-
 }

http://git-wip-us.apache.org/repos/asf/incubator-fluo-recipes/blob/3ee37719/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index abdc1fa..e6f9a28 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,7 +22,7 @@
   </parent>
   <groupId>org.apache.fluo</groupId>
   <artifactId>fluo-recipes-parent</artifactId>
-  <version>1.0.0-beta-3-SNAPSHOT</version>
+  <version>1.0.0-incubating-SNAPSHOT</version>
   <packaging>pom</packaging>
   <name>Fluo Recipes Parent</name>
   <description>Implementation of Common Fluo patterns</description>
@@ -51,7 +51,7 @@
     <url>https://github.com/apache/incubator-fluo-recipes/issues</url>
   </issueManagement>
   <properties>
-    <accumulo.version>1.7.1</accumulo.version>
+    <accumulo.version>1.6.5</accumulo.version>
     <findbugs.maxRank>13</findbugs.maxRank>
     <fluo.version>1.0.0-incubating-SNAPSHOT</fluo.version>
     <hadoop.version>2.6.3</hadoop.version>
@@ -204,6 +204,13 @@
             </archive>
           </configuration>
         </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-javadoc-plugin</artifactId>
+          <configuration>
+            <excludePackageNames>*.impl.*</excludePackageNames>
+          </configuration>
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>