You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gobblin.apache.org by ab...@apache.org on 2017/07/31 07:53:02 UTC
[44/77] [abbrv] incubator-gobblin git commit: Changed JavaDocs
references from gobblin to org.apache.gobblin package
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/main/java/org/apache/gobblin/util/WriterUtils.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/main/java/org/apache/gobblin/util/WriterUtils.java b/gobblin-utility/src/main/java/org/apache/gobblin/util/WriterUtils.java
index 803b0ba..2ac292f 100644
--- a/gobblin-utility/src/main/java/org/apache/gobblin/util/WriterUtils.java
+++ b/gobblin-utility/src/main/java/org/apache/gobblin/util/WriterUtils.java
@@ -42,7 +42,7 @@ import org.apache.gobblin.source.workunit.WorkUnit;
/**
- * Utility class for use with the {@link gobblin.writer.DataWriter} class.
+ * Utility class for use with the {@link org.apache.gobblin.writer.DataWriter} class.
*/
@Slf4j
public class WriterUtils {
@@ -59,13 +59,13 @@ public class WriterUtils {
}
/**
- * Get the {@link Path} corresponding the to the directory a given {@link gobblin.writer.DataWriter} should be writing
+ * Get the {@link Path} corresponding the to the directory a given {@link org.apache.gobblin.writer.DataWriter} should be writing
* its staging data. The staging data directory is determined by combining the
* {@link ConfigurationKeys#WRITER_STAGING_DIR} and the {@link ConfigurationKeys#WRITER_FILE_PATH}.
- * @param state is the {@link State} corresponding to a specific {@link gobblin.writer.DataWriter}.
+ * @param state is the {@link State} corresponding to a specific {@link org.apache.gobblin.writer.DataWriter}.
* @param numBranches is the total number of branches for the given {@link State}.
- * @param branchId is the id for the specific branch that the {@link gobblin.writer.DataWriter} will write to.
- * @return a {@link Path} specifying the directory where the {@link gobblin.writer.DataWriter} will write to.
+ * @param branchId is the id for the specific branch that the {@link org.apache.gobblin.writer.DataWriter} will write to.
+ * @return a {@link Path} specifying the directory where the {@link org.apache.gobblin.writer.DataWriter} will write to.
*/
public static Path getWriterStagingDir(State state, int numBranches, int branchId) {
String writerStagingDirKey =
@@ -80,7 +80,7 @@ public class WriterUtils {
}
/**
- * Get the staging {@link Path} for {@link gobblin.writer.DataWriter} that has attemptId in the path.
+ * Get the staging {@link Path} for {@link org.apache.gobblin.writer.DataWriter} that has attemptId in the path.
*/
public static Path getWriterStagingDir(State state, int numBranches, int branchId, String attemptId) {
Preconditions.checkArgument(attemptId != null && !attemptId.isEmpty(), "AttemptId cannot be null or empty: " + attemptId);
@@ -88,13 +88,13 @@ public class WriterUtils {
}
/**
- * Get the {@link Path} corresponding the to the directory a given {@link gobblin.writer.DataWriter} should be writing
+ * Get the {@link Path} corresponding the to the directory a given {@link org.apache.gobblin.writer.DataWriter} should be writing
* its output data. The output data directory is determined by combining the
* {@link ConfigurationKeys#WRITER_OUTPUT_DIR} and the {@link ConfigurationKeys#WRITER_FILE_PATH}.
- * @param state is the {@link State} corresponding to a specific {@link gobblin.writer.DataWriter}.
+ * @param state is the {@link State} corresponding to a specific {@link org.apache.gobblin.writer.DataWriter}.
* @param numBranches is the total number of branches for the given {@link State}.
- * @param branchId is the id for the specific branch that the {@link gobblin.writer.DataWriter} will write to.
- * @return a {@link Path} specifying the directory where the {@link gobblin.writer.DataWriter} will write to.
+ * @param branchId is the id for the specific branch that the {@link org.apache.gobblin.writer.DataWriter} will write to.
+ * @return a {@link Path} specifying the directory where the {@link org.apache.gobblin.writer.DataWriter} will write to.
*/
public static Path getWriterOutputDir(State state, int numBranches, int branchId) {
String writerOutputDirKey =
@@ -105,13 +105,13 @@ public class WriterUtils {
}
/**
- * Get the {@link Path} corresponding the to the directory a given {@link gobblin.publisher.BaseDataPublisher} should
+ * Get the {@link Path} corresponding the to the directory a given {@link org.apache.gobblin.publisher.BaseDataPublisher} should
* commits its output data. The final output data directory is determined by combining the
* {@link ConfigurationKeys#DATA_PUBLISHER_FINAL_DIR} and the {@link ConfigurationKeys#WRITER_FILE_PATH}.
- * @param state is the {@link State} corresponding to a specific {@link gobblin.writer.DataWriter}.
+ * @param state is the {@link State} corresponding to a specific {@link org.apache.gobblin.writer.DataWriter}.
* @param numBranches is the total number of branches for the given {@link State}.
- * @param branchId is the id for the specific branch that the {@link gobblin.publisher.BaseDataPublisher} will publish.
- * @return a {@link Path} specifying the directory where the {@link gobblin.publisher.BaseDataPublisher} will publish.
+ * @param branchId is the id for the specific branch that the {@link org.apache.gobblin.publisher.BaseDataPublisher} will publish.
+ * @return a {@link Path} specifying the directory where the {@link org.apache.gobblin.publisher.BaseDataPublisher} will publish.
*/
public static Path getDataPublisherFinalDir(State state, int numBranches, int branchId) {
String dataPublisherFinalDirKey =
@@ -131,14 +131,14 @@ public class WriterUtils {
}
/**
- * Get the {@link Path} corresponding the the relative file path for a given {@link gobblin.writer.DataWriter}.
+ * Get the {@link Path} corresponding the the relative file path for a given {@link org.apache.gobblin.writer.DataWriter}.
* This method retrieves the value of {@link ConfigurationKeys#WRITER_FILE_PATH} from the given {@link State}. It also
* constructs the default value of the {@link ConfigurationKeys#WRITER_FILE_PATH} if not is not specified in the given
* {@link State}.
- * @param state is the {@link State} corresponding to a specific {@link gobblin.writer.DataWriter}.
+ * @param state is the {@link State} corresponding to a specific {@link org.apache.gobblin.writer.DataWriter}.
* @param numBranches is the total number of branches for the given {@link State}.
- * @param branchId is the id for the specific branch that the {{@link gobblin.writer.DataWriter} will write to.
- * @return a {@link Path} specifying the relative directory where the {@link gobblin.writer.DataWriter} will write to.
+ * @param branchId is the id for the specific branch that the {{@link org.apache.gobblin.writer.DataWriter} will write to.
+ * @return a {@link Path} specifying the relative directory where the {@link org.apache.gobblin.writer.DataWriter} will write to.
*/
public static Path getWriterFilePath(State state, int numBranches, int branchId) {
if (state.contains(
@@ -175,8 +175,8 @@ public class WriterUtils {
/**
* Creates the default {@link Path} for the {@link ConfigurationKeys#WRITER_FILE_PATH} key.
* @param numBranches is the total number of branches for the given {@link State}.
- * @param branchId is the id for the specific branch that the {@link gobblin.writer.DataWriter} will write to.
- * @return a {@link Path} specifying the directory where the {@link gobblin.writer.DataWriter} will write to.
+ * @param branchId is the id for the specific branch that the {@link org.apache.gobblin.writer.DataWriter} will write to.
+ * @return a {@link Path} specifying the directory where the {@link org.apache.gobblin.writer.DataWriter} will write to.
*/
public static Path getDefaultWriterFilePath(State state, int numBranches, int branchId) {
if (state instanceof WorkUnitState) {
@@ -195,13 +195,13 @@ public class WriterUtils {
}
/**
- * Get the value of {@link ConfigurationKeys#WRITER_FILE_NAME} for the a given {@link gobblin.writer.DataWriter}. The
+ * Get the value of {@link ConfigurationKeys#WRITER_FILE_NAME} for the a given {@link org.apache.gobblin.writer.DataWriter}. The
* method also constructs the default value of the {@link ConfigurationKeys#WRITER_FILE_NAME} if it is not set in the
* {@link State}
- * @param state is the {@link State} corresponding to a specific {@link gobblin.writer.DataWriter}.
+ * @param state is the {@link State} corresponding to a specific {@link org.apache.gobblin.writer.DataWriter}.
* @param numBranches is the total number of branches for the given {@link State}.
- * @param branchId is the id for the specific branch that the {{@link gobblin.writer.DataWriter} will write to.
- * @param writerId is the id for a specific {@link gobblin.writer.DataWriter}.
+ * @param branchId is the id for the specific branch that the {{@link org.apache.gobblin.writer.DataWriter} will write to.
+ * @param writerId is the id for a specific {@link org.apache.gobblin.writer.DataWriter}.
* @param formatExtension is the format extension for the file (e.g. ".avro").
* @return a {@link String} representation of the file name.
*/
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/main/java/org/apache/gobblin/util/callbacks/package-info.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/main/java/org/apache/gobblin/util/callbacks/package-info.java b/gobblin-utility/src/main/java/org/apache/gobblin/util/callbacks/package-info.java
index 759ae5d..6cec9d6 100644
--- a/gobblin-utility/src/main/java/org/apache/gobblin/util/callbacks/package-info.java
+++ b/gobblin-utility/src/main/java/org/apache/gobblin/util/callbacks/package-info.java
@@ -22,13 +22,13 @@
* <dt>Listeners</dt>
* <dd>Listeners are the object to which the callbacks are sent. This package does not impose
* too many restrictions on what listeners should look like. For a given
- * {@link gobblin.util.callbacks.CallbacksDispatcher}, they should all implement the same
+ * {@link org.apache.gobblin.util.callbacks.CallbacksDispatcher}, they should all implement the same
* interface. </dd>
* <dt>Callbacks</dt>
* <dd>Callbacks are represented as {@link com.google.common.base.Function}<L, R> instances which
* take one L parameter, the listener to be applied on, and can return a result of type R. If no
* meaningful result is returned, R should be Void. There is a helper class
- * {@link gobblin.util.callbacks.Callback} which allows to assign a meaningful string to the
+ * {@link org.apache.gobblin.util.callbacks.Callback} which allows to assign a meaningful string to the
* callback. Typically, this is the name of the callback and short description of any bound
* arguments.
*
@@ -45,15 +45,15 @@
* </ul>
* </dd>
* <dt>Callbacks Dispatcher</dt>
- * <dd> The {@link gobblin.util.callbacks.CallbacksDispatcher}<L> is responsible for:
+ * <dd> The {@link org.apache.gobblin.util.callbacks.CallbacksDispatcher}<L> is responsible for:
* <ul>
* <li>Maintaining a list of listeners of type L.
- * <li>Dispatch callbacks invoked through {@link gobblin.util.callbacks.CallbacksDispatcher#execCallbacks(com.google.common.base.Function)}
+ * <li>Dispatch callbacks invoked through {@link org.apache.gobblin.util.callbacks.CallbacksDispatcher#execCallbacks(com.google.common.base.Function)}
* to each of the above listeners.
* <li>Provide parallelism of the callbacks if necessary.
* <li>Guarantee isolation of failures in callbacks.
* <li>Provide logging for debugging purposes.
- * <li>Classify callback results in {@link gobblin.util.callbacks.CallbacksDispatcher.CallbackResults}
+ * <li>Classify callback results in {@link org.apache.gobblin.util.callbacks.CallbacksDispatcher.CallbackResults}
* for easier upstream processing.
* </ul>
* </dd>
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/main/java/org/apache/gobblin/util/filesystem/PathAlterationObserverScheduler.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/main/java/org/apache/gobblin/util/filesystem/PathAlterationObserverScheduler.java b/gobblin-utility/src/main/java/org/apache/gobblin/util/filesystem/PathAlterationObserverScheduler.java
index 7321a0a..12e0f5d 100644
--- a/gobblin-utility/src/main/java/org/apache/gobblin/util/filesystem/PathAlterationObserverScheduler.java
+++ b/gobblin-utility/src/main/java/org/apache/gobblin/util/filesystem/PathAlterationObserverScheduler.java
@@ -172,7 +172,7 @@ public final class PathAlterationObserverScheduler implements Runnable {
* root directory and any nested subdirectories under the root directory to the given
* {@link PathAlterationObserverScheduler}.
* @param detector a {@link PathAlterationObserverScheduler}
- * @param listener a {@link gobblin.util.filesystem.PathAlterationListener}
+ * @param listener a {@link org.apache.gobblin.util.filesystem.PathAlterationListener}
* @param observerOptional Optional observer object. For testing routine, this has been initialized by user.
* But for general usage, the observer object is created inside this method.
* @param rootDirPath root directory
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/main/java/org/apache/gobblin/util/limiter/Limiter.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/main/java/org/apache/gobblin/util/limiter/Limiter.java b/gobblin-utility/src/main/java/org/apache/gobblin/util/limiter/Limiter.java
index 44b2ff9..2c2efb4 100644
--- a/gobblin-utility/src/main/java/org/apache/gobblin/util/limiter/Limiter.java
+++ b/gobblin-utility/src/main/java/org/apache/gobblin/util/limiter/Limiter.java
@@ -22,7 +22,7 @@ import java.io.Closeable;
/**
* An interface for classes that implement some logic limiting on the occurrences of some events,
- * e.g., data record extraction using an {@link gobblin.source.extractor.Extractor}.
+ * e.g., data record extraction using an {@link org.apache.gobblin.source.extractor.Extractor}.
*
* @author Yinan Li
*/
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/test/java/org/apache/gobblin/util/AvroUtilsTest.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/test/java/org/apache/gobblin/util/AvroUtilsTest.java b/gobblin-utility/src/test/java/org/apache/gobblin/util/AvroUtilsTest.java
index 5114599..cadc507 100644
--- a/gobblin-utility/src/test/java/org/apache/gobblin/util/AvroUtilsTest.java
+++ b/gobblin-utility/src/test/java/org/apache/gobblin/util/AvroUtilsTest.java
@@ -226,8 +226,8 @@ public class AvroUtilsTest {
}
/**
- * This is a test to validate support of maps in {@link gobblin.util.AvroUtils#getFieldValue(GenericRecord, String)}
- * and {@link gobblin.util.AvroUtils#getFieldSchema(Schema, String)}
+ * This is a test to validate support of maps in {@link org.apache.gobblin.util.AvroUtils#getFieldValue(GenericRecord, String)}
+ * and {@link org.apache.gobblin.util.AvroUtils#getFieldSchema(Schema, String)}
* @throws IOException
*/
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/test/java/org/apache/gobblin/util/FileListUtilsTest.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/test/java/org/apache/gobblin/util/FileListUtilsTest.java b/gobblin-utility/src/test/java/org/apache/gobblin/util/FileListUtilsTest.java
index 547af08..415ae54 100644
--- a/gobblin-utility/src/test/java/org/apache/gobblin/util/FileListUtilsTest.java
+++ b/gobblin-utility/src/test/java/org/apache/gobblin/util/FileListUtilsTest.java
@@ -33,7 +33,7 @@ import com.google.common.collect.Sets;
/**
- * Unit tests for the job configuration file monitor in {@link gobblin.util.FileListUtils}.
+ * Unit tests for the job configuration file monitor in {@link org.apache.gobblin.util.FileListUtils}.
*/
@Test(groups = { "gobblin.util" })
public class FileListUtilsTest {
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/test/java/org/apache/gobblin/util/test/BaseClass.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/test/java/org/apache/gobblin/util/test/BaseClass.java b/gobblin-utility/src/test/java/org/apache/gobblin/util/test/BaseClass.java
index bbb1c54..4d1d7c7 100644
--- a/gobblin-utility/src/test/java/org/apache/gobblin/util/test/BaseClass.java
+++ b/gobblin-utility/src/test/java/org/apache/gobblin/util/test/BaseClass.java
@@ -23,7 +23,7 @@ import java.util.Random;
/**
- * Used for {@link gobblin.util.io.GsonInterfaceAdapterTest}.
+ * Used for {@link org.apache.gobblin.util.io.GsonInterfaceAdapterTest}.
*/
@EqualsAndHashCode
public class BaseClass {
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/test/java/org/apache/gobblin/util/test/ExtendedClass.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/test/java/org/apache/gobblin/util/test/ExtendedClass.java b/gobblin-utility/src/test/java/org/apache/gobblin/util/test/ExtendedClass.java
index beec266..32d43cc 100644
--- a/gobblin-utility/src/test/java/org/apache/gobblin/util/test/ExtendedClass.java
+++ b/gobblin-utility/src/test/java/org/apache/gobblin/util/test/ExtendedClass.java
@@ -23,7 +23,7 @@ import java.util.Random;
/**
- * Used for {@link gobblin.util.io.GsonInterfaceAdapterTest}.
+ * Used for {@link org.apache.gobblin.util.io.GsonInterfaceAdapterTest}.
*/
@EqualsAndHashCode(callSuper = true)
public class ExtendedClass extends BaseClass {
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-utility/src/test/java/org/apache/gobblin/util/test/TestClass.java
----------------------------------------------------------------------
diff --git a/gobblin-utility/src/test/java/org/apache/gobblin/util/test/TestClass.java b/gobblin-utility/src/test/java/org/apache/gobblin/util/test/TestClass.java
index 26d32b8..fd1947c 100644
--- a/gobblin-utility/src/test/java/org/apache/gobblin/util/test/TestClass.java
+++ b/gobblin-utility/src/test/java/org/apache/gobblin/util/test/TestClass.java
@@ -29,7 +29,7 @@ import com.google.common.collect.Maps;
/**
- * Used for {@link gobblin.util.io.GsonInterfaceAdapterTest}.
+ * Used for {@link org.apache.gobblin.util.io.GsonInterfaceAdapterTest}.
*/
@EqualsAndHashCode(callSuper = true)
public class TestClass extends BaseClass {
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnEventConstants.java
----------------------------------------------------------------------
diff --git a/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnEventConstants.java b/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnEventConstants.java
index 907d8c2..80441d4 100644
--- a/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnEventConstants.java
+++ b/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnEventConstants.java
@@ -18,7 +18,7 @@
package org.apache.gobblin.yarn;
/**
- * YARN specific event constants to be used with an {@link gobblin.metrics.event.EventSubmitter}.
+ * YARN specific event constants to be used with an {@link org.apache.gobblin.metrics.event.EventSubmitter}.
*/
public class GobblinYarnEventConstants {
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnMetricTagNames.java
----------------------------------------------------------------------
diff --git a/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnMetricTagNames.java b/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnMetricTagNames.java
index 2269a37..e08de27 100644
--- a/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnMetricTagNames.java
+++ b/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnMetricTagNames.java
@@ -18,7 +18,7 @@
package org.apache.gobblin.yarn;
/**
- * A central place for constants of {@link gobblin.metrics.MetricContext} tag names for Gobblin on Yarn.
+ * A central place for constants of {@link org.apache.gobblin.metrics.MetricContext} tag names for Gobblin on Yarn.
*
* @author Yinan Li
*/
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnTaskRunner.java
----------------------------------------------------------------------
diff --git a/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnTaskRunner.java b/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnTaskRunner.java
index 60dd4d3..d1af4fd 100644
--- a/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnTaskRunner.java
+++ b/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/GobblinYarnTaskRunner.java
@@ -111,7 +111,7 @@ public class GobblinYarnTaskRunner extends GobblinTaskRunner {
* Currently it handles the following sub types of messages:
*
* <ul>
- * <li>{@link gobblin.cluster.HelixMessageSubTypes#TOKEN_FILE_UPDATED}</li>
+ * <li>{@link org.apache.gobblin.cluster.HelixMessageSubTypes#TOKEN_FILE_UPDATED}</li>
* </ul>
* </p>
*/
http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/177a42de/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/event/GetApplicationReportFailureEvent.java
----------------------------------------------------------------------
diff --git a/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/event/GetApplicationReportFailureEvent.java b/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/event/GetApplicationReportFailureEvent.java
index 0527ff8..103ac01 100644
--- a/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/event/GetApplicationReportFailureEvent.java
+++ b/gobblin-yarn/src/main/java/org/apache/gobblin/yarn/event/GetApplicationReportFailureEvent.java
@@ -21,7 +21,7 @@ import org.apache.hadoop.yarn.api.records.ApplicationReport;
/**
- * A type of events posted when the {@link gobblin.yarn.GobblinYarnAppLauncher} fails to get
+ * A type of events posted when the {@link org.apache.gobblin.yarn.GobblinYarnAppLauncher} fails to get
* the {@link ApplicationReport} of the Gobblin Yarn application.
*
* @author Yinan Li