[SPARK-21671][CORE] Move kvstore to "util" sub-package, add private a…

…nnotation. Author: Marcelo Vanzin <vanzin@cloudera.com> Closes #18886 from vanzin/SPARK-21671.
apache · Aug 8, 2017 · 2c1bfb4 · 2c1bfb4
1 parent 979bf94
commit 2c1bfb4
Show file tree

Hide file tree

Showing 22 changed files with 46 additions and 22 deletions.
diff --git a/...g/apache/spark/kvstore/ArrayWrappers.java → ...che/spark/util/kvstore/ArrayWrappers.java b/...g/apache/spark/kvstore/ArrayWrappers.java → ...che/spark/util/kvstore/ArrayWrappers.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.util.Arrays;
 

diff --git a/...g/apache/spark/kvstore/InMemoryStore.java → ...che/spark/util/kvstore/InMemoryStore.java b/...g/apache/spark/kvstore/InMemoryStore.java → ...che/spark/util/kvstore/InMemoryStore.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.util.ArrayList;
 import java.util.Collection;

diff --git a/...ava/org/apache/spark/kvstore/KVIndex.java → ...rg/apache/spark/util/kvstore/KVIndex.java b/...ava/org/apache/spark/kvstore/KVIndex.java → ...rg/apache/spark/util/kvstore/KVIndex.java
@@ -15,13 +15,15 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.apache.spark.annotation.Private;
+
 /**
  * Tags a field to be indexed when storing an object.
  *
@@ -46,6 +48,7 @@
  * of those values.
  * </p>
  */
+@Private
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.FIELD, ElementType.METHOD})
 public @interface KVIndex {

diff --git a/...ava/org/apache/spark/kvstore/KVStore.java → ...rg/apache/spark/util/kvstore/KVStore.java b/...ava/org/apache/spark/kvstore/KVStore.java → ...rg/apache/spark/util/kvstore/KVStore.java
@@ -15,10 +15,12 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.io.Closeable;
 
+import org.apache.spark.annotation.Private;
+
 /**
  * Abstraction for a local key/value store for storing app data.
  *
@@ -59,6 +61,7 @@
  * KVStore instances are thread-safe for both reads and writes.
  * </p>
  */
+@Private
 public interface KVStore extends Closeable {
 
   /**

diff --git a/...apache/spark/kvstore/KVStoreIterator.java → ...e/spark/util/kvstore/KVStoreIterator.java b/...apache/spark/kvstore/KVStoreIterator.java → ...e/spark/util/kvstore/KVStoreIterator.java
@@ -15,11 +15,13 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.util.Iterator;
 import java.util.List;
 
+import org.apache.spark.annotation.Private;
+
 /**
  * An iterator for KVStore.
  *
@@ -28,6 +30,7 @@
  * explicitly close iterators after they're used.
  * </p>
  */
+@Private
 public interface KVStoreIterator<T> extends Iterator<T>, AutoCloseable {
 
   /**

diff --git a/...ache/spark/kvstore/KVStoreSerializer.java → ...spark/util/kvstore/KVStoreSerializer.java b/...ache/spark/kvstore/KVStoreSerializer.java → ...spark/util/kvstore/KVStoreSerializer.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
@@ -25,6 +25,8 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 
+import org.apache.spark.annotation.Private;
+
 /**
  * Serializer used to translate between app-defined types and the LevelDB store.
  *
@@ -33,6 +35,7 @@
  * and integers to be written as values directly, which will be written as UTF-8 strings.
  * </p>
  */
+@Private
 public class KVStoreSerializer {
 
   /**

diff --git a/...org/apache/spark/kvstore/KVStoreView.java → ...pache/spark/util/kvstore/KVStoreView.java b/...org/apache/spark/kvstore/KVStoreView.java → ...pache/spark/util/kvstore/KVStoreView.java
@@ -15,10 +15,12 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import com.google.common.base.Preconditions;
 
+import org.apache.spark.annotation.Private;
+
 /**
  * A configurable view that allows iterating over values in a {@link KVStore}.
  *
@@ -33,6 +35,7 @@
  * to be closed explicitly unless all elements are read.
  * </p>
  */
+@Private
 public abstract class KVStoreView<T> implements Iterable<T> {
 
   final Class<T> type;

diff --git a/.../org/apache/spark/kvstore/KVTypeInfo.java → ...apache/spark/util/kvstore/KVTypeInfo.java b/.../org/apache/spark/kvstore/KVTypeInfo.java → ...apache/spark/util/kvstore/KVTypeInfo.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
@@ -25,9 +25,12 @@
 
 import com.google.common.base.Preconditions;
 
+import org.apache.spark.annotation.Private;
+
 /**
  * Wrapper around types managed in a KVStore, providing easy access to their indexed fields.
  */
+@Private
 public class KVTypeInfo {
 
   private final Class<?> type;

diff --git a/...ava/org/apache/spark/kvstore/LevelDB.java → ...rg/apache/spark/util/kvstore/LevelDB.java b/...ava/org/apache/spark/kvstore/LevelDB.java → ...rg/apache/spark/util/kvstore/LevelDB.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.io.File;
 import java.io.IOException;
@@ -36,9 +36,12 @@
 import org.iq80.leveldb.Options;
 import org.iq80.leveldb.WriteBatch;
 
+import org.apache.spark.annotation.Private;
+
 /**
  * Implementation of KVStore that uses LevelDB as the underlying data store.
  */
+@Private
 public class LevelDB implements KVStore {
 
   @VisibleForTesting

diff --git a/...apache/spark/kvstore/LevelDBIterator.java → ...e/spark/util/kvstore/LevelDBIterator.java b/...apache/spark/kvstore/LevelDBIterator.java → ...e/spark/util/kvstore/LevelDBIterator.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.io.IOException;
 import java.util.ArrayList;

diff --git a/...apache/spark/kvstore/LevelDBTypeInfo.java → ...e/spark/util/kvstore/LevelDBTypeInfo.java b/...apache/spark/kvstore/LevelDBTypeInfo.java → ...e/spark/util/kvstore/LevelDBTypeInfo.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.lang.reflect.Array;
 import java.util.Collection;

diff --git a/...ore/UnsupportedStoreVersionException.java → ...ore/UnsupportedStoreVersionException.java b/...ore/UnsupportedStoreVersionException.java → ...ore/UnsupportedStoreVersionException.java
@@ -15,13 +15,16 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.io.IOException;
 
+import org.apache.spark.annotation.Private;
+
 /**
  * Exception thrown when the store implementation is not compatible with the underlying data.
  */
+@Private
 public class UnsupportedStoreVersionException extends IOException {
 
 }
diff --git a/...ache/spark/kvstore/ArrayKeyIndexType.java → ...spark/util/kvstore/ArrayKeyIndexType.java b/...ache/spark/kvstore/ArrayKeyIndexType.java → ...spark/util/kvstore/ArrayKeyIndexType.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.util.Arrays;
 

diff --git a/...che/spark/kvstore/ArrayWrappersSuite.java → ...park/util/kvstore/ArrayWrappersSuite.java b/...che/spark/kvstore/ArrayWrappersSuite.java → ...park/util/kvstore/ArrayWrappersSuite.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import org.junit.Test;
 import static org.junit.Assert.*;

diff --git a/...org/apache/spark/kvstore/CustomType1.java → ...pache/spark/util/kvstore/CustomType1.java b/...org/apache/spark/kvstore/CustomType1.java → ...pache/spark/util/kvstore/CustomType1.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import com.google.common.base.Objects;
 

diff --git a/...apache/spark/kvstore/DBIteratorSuite.java → ...e/spark/util/kvstore/DBIteratorSuite.java b/...apache/spark/kvstore/DBIteratorSuite.java → ...e/spark/util/kvstore/DBIteratorSuite.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.util.Arrays;
 import java.util.ArrayList;

diff --git a/.../spark/kvstore/InMemoryIteratorSuite.java → ...k/util/kvstore/InMemoryIteratorSuite.java b/.../spark/kvstore/InMemoryIteratorSuite.java → ...k/util/kvstore/InMemoryIteratorSuite.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 public class InMemoryIteratorSuite extends DBIteratorSuite {
 

diff --git a/...che/spark/kvstore/InMemoryStoreSuite.java → ...park/util/kvstore/InMemoryStoreSuite.java b/...che/spark/kvstore/InMemoryStoreSuite.java → ...park/util/kvstore/InMemoryStoreSuite.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.util.NoSuchElementException;
 

diff --git a/...pache/spark/kvstore/LevelDBBenchmark.java → .../spark/util/kvstore/LevelDBBenchmark.java b/...pache/spark/kvstore/LevelDBBenchmark.java → .../spark/util/kvstore/LevelDBBenchmark.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.io.File;
 import java.util.ArrayList;

diff --git a/...e/spark/kvstore/LevelDBIteratorSuite.java → ...rk/util/kvstore/LevelDBIteratorSuite.java b/...e/spark/kvstore/LevelDBIteratorSuite.java → ...rk/util/kvstore/LevelDBIteratorSuite.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.io.File;
 

diff --git a/...rg/apache/spark/kvstore/LevelDBSuite.java → ...ache/spark/util/kvstore/LevelDBSuite.java b/...rg/apache/spark/kvstore/LevelDBSuite.java → ...ache/spark/util/kvstore/LevelDBSuite.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import java.io.File;
 import java.util.Arrays;

diff --git a/...e/spark/kvstore/LevelDBTypeInfoSuite.java → ...rk/util/kvstore/LevelDBTypeInfoSuite.java b/...e/spark/kvstore/LevelDBTypeInfoSuite.java → ...rk/util/kvstore/LevelDBTypeInfoSuite.java
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.spark.kvstore;
+package org.apache.spark.util.kvstore;
 
 import static java.nio.charset.StandardCharsets.UTF_8;