1
0

Fix javadoc issues. Prelude to pushing libs to maven central

This commit is contained in:
Prasanna Rajaperumal
2016-12-21 17:34:29 -08:00
parent 12885ab60a
commit b6d8e857f0
11 changed files with 20 additions and 169 deletions

View File

@@ -60,7 +60,7 @@ import scala.Tuple2;
* Provides first class support for accessing Hoodie tables for data processing via Apache Spark.
*
*
* TODO: Need to move all read operations here, since Hoodie is a single writer & multiple reader
* TODO: Need to move all read operations here, since Hoodie is a single writer and multiple reader
*/
public class HoodieReadClient implements Serializable {
@@ -247,7 +247,7 @@ public class HoodieReadClient implements Serializable {
/**
* Checks if the given [Keys] exists in the hoodie table and returns [Key,
* Optional<FullFilePath>] If the optional FullFilePath value is not present, then the key is
* Optional[FullFilePath]] If the optional FullFilePath value is not present, then the key is
* not found. If the FullFilePath value is present, it is the path component (without scheme) of
* the URI underlying file
*/

View File

@@ -105,7 +105,6 @@ public class HoodieWriteClient<T extends HoodieRecordPayload> implements Seriali
* @param jsc
* @param clientConfig
* @param rollbackInFlight
* @throws Exception
*/
public HoodieWriteClient(JavaSparkContext jsc, HoodieWriteConfig clientConfig, boolean rollbackInFlight) {
this.fs = FSUtils.getFs();
@@ -234,7 +233,7 @@ public class HoodieWriteClient<T extends HoodieRecordPayload> implements Seriali
*
* @param records HoodieRecords to insert
* @param commitTime Commit Time handle
* @return JavaRDD<WriteStatus> - RDD of WriteStatus to inspect errors and counts
* @return JavaRDD[WriteStatus] - RDD of WriteStatus to inspect errors and counts
*
*/
public JavaRDD<WriteStatus> insert(JavaRDD<HoodieRecord<T>> records, final String commitTime) {

View File

@@ -33,7 +33,7 @@ import java.io.Serializable;
/**
* Base class for different types of indexes to determine the mapping from uuid
* <p/>
*
* TODO(vc): need methods for recovery and rollback
*/
public abstract class HoodieIndex<T extends HoodieRecordPayload> implements Serializable {
@@ -53,7 +53,7 @@ public abstract class HoodieIndex<T extends HoodieRecordPayload> implements Seri
}
/**
* Checks if the given [Keys] exists in the hoodie table and returns [Key, Optional<FullFilePath>]
* Checks if the given [Keys] exists in the hoodie table and returns [Key, Optional[FullFilePath]]
* If the optional FullFilePath value is not present, then the key is not found. If the FullFilePath
* value is present, it is the path component (without scheme) of the URI underlying file
*
@@ -74,7 +74,7 @@ public abstract class HoodieIndex<T extends HoodieRecordPayload> implements Seri
/**
* Extracts the location of written records, and updates the index.
* <p/>
*
* TODO(vc): We may need to propagate the record as well in a WriteStatus class
*/
public abstract JavaRDD<WriteStatus> updateLocation(JavaRDD<WriteStatus> writeStatusRDD,

View File

@@ -64,9 +64,9 @@ public class HoodieInsertHandle<T extends HoodieRecordPayload> extends HoodieIOH
/**
* Determines whether we can accept the incoming records, into the current file, depending on
* <p/>
*
* - Whether it belongs to the same partitionPath as existing records
* - Whether the current file written bytes < max file size
* - Whether the current file written bytes lt max file size
*
* @return
*/

View File

@@ -26,11 +26,7 @@ import org.apache.commons.configuration.ConfigurationException;
import java.io.Closeable;
/**
* This is the main class of the metrics system. To use it,
* users need to call the {@link #init(HoodieMetricsConfig) init} method to initialize the system.
* Input for {@link #init(HoodieMetricsConfig) init} includes a configuration object, where
* users can specify the reporter type, and special configs for that reporter.
* Refer to {@see MetricsConfiguration} for more configurable fields.
* This is the main class of the metrics system.
*/
public class Metrics {
private static volatile boolean initialized = false;

View File

@@ -115,7 +115,7 @@ public class HoodieCopyOnWriteTable<T extends HoodieRecordPayload> extends Hoodi
}
/**
* Helper class for a bucket's type (INSERT & UPDATE) and its file location
* Helper class for a bucket's type (INSERT and UPDATE) and its file location
*/
class BucketInfo implements Serializable {
BucketType bucketType;