You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@twill.apache.org by ch...@apache.org on 2015/07/24 20:29:41 UTC
[07/25] incubator-twill git commit: Add more missing JavaDoc class
header information.
Add more missing JavaDoc class header information.
This closes #37 on GitHub
Signed-off-by: Terence Yim <ch...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/incubator-twill/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-twill/commit/ca33245c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-twill/tree/ca33245c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-twill/diff/ca33245c
Branch: refs/heads/site
Commit: ca33245cb086d9598479f1317d59e5dc26bf0ca0
Parents: d8462a4
Author: hsaputra <hs...@apache.org>
Authored: Mon Jun 1 21:37:34 2015 -0700
Committer: Terence Yim <ch...@apache.org>
Committed: Fri Jun 12 18:04:48 2015 -0700
----------------------------------------------------------------------
.../java/org/apache/twill/internal/BasicTwillContext.java | 3 ++-
.../java/org/apache/twill/internal/ProcessLauncher.java | 2 +-
.../org/apache/twill/internal/TwillContainerLauncher.java | 10 ++++++++++
.../org/apache/twill/internal/logging/KafkaAppender.java | 2 +-
.../apache/twill/internal/yarn/Hadoop21YarnAMClient.java | 2 +-
.../apache/twill/internal/yarn/Hadoop21YarnNMClient.java | 2 +-
.../internal/appmaster/ApplicationMasterService.java | 2 +-
.../twill/internal/container/TwillContainerMain.java | 2 +-
8 files changed, 18 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/ca33245c/twill-core/src/main/java/org/apache/twill/internal/BasicTwillContext.java
----------------------------------------------------------------------
diff --git a/twill-core/src/main/java/org/apache/twill/internal/BasicTwillContext.java b/twill-core/src/main/java/org/apache/twill/internal/BasicTwillContext.java
index 94e6a69..370c3d3 100644
--- a/twill-core/src/main/java/org/apache/twill/internal/BasicTwillContext.java
+++ b/twill-core/src/main/java/org/apache/twill/internal/BasicTwillContext.java
@@ -20,6 +20,7 @@ package org.apache.twill.internal;
import org.apache.twill.api.ElectionHandler;
import org.apache.twill.api.RunId;
import org.apache.twill.api.TwillContext;
+import org.apache.twill.api.TwillRunnable;
import org.apache.twill.api.TwillRunnableSpecification;
import org.apache.twill.common.Cancellable;
import org.apache.twill.discovery.Discoverable;
@@ -34,7 +35,7 @@ import java.net.InetSocketAddress;
import java.util.concurrent.locks.Lock;
/**
- *
+ * Implementation of {@link TwillContext} that provides the basic runtime information of a {@link TwillRunnable}.
*/
public final class BasicTwillContext implements TwillContext {
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/ca33245c/twill-core/src/main/java/org/apache/twill/internal/ProcessLauncher.java
----------------------------------------------------------------------
diff --git a/twill-core/src/main/java/org/apache/twill/internal/ProcessLauncher.java b/twill-core/src/main/java/org/apache/twill/internal/ProcessLauncher.java
index 098b90e..d0f289b 100644
--- a/twill-core/src/main/java/org/apache/twill/internal/ProcessLauncher.java
+++ b/twill-core/src/main/java/org/apache/twill/internal/ProcessLauncher.java
@@ -45,7 +45,7 @@ public interface ProcessLauncher<T> {
interface PrepareLaunchContext {
/**
- * Adds list of files to be localized for the container
+ * Adds list of files to be localized for the container.
*/
PrepareLaunchContext addResources(LocalFile...localFiles);
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/ca33245c/twill-core/src/main/java/org/apache/twill/internal/TwillContainerLauncher.java
----------------------------------------------------------------------
diff --git a/twill-core/src/main/java/org/apache/twill/internal/TwillContainerLauncher.java b/twill-core/src/main/java/org/apache/twill/internal/TwillContainerLauncher.java
index 02606cd..0667bb4 100644
--- a/twill-core/src/main/java/org/apache/twill/internal/TwillContainerLauncher.java
+++ b/twill-core/src/main/java/org/apache/twill/internal/TwillContainerLauncher.java
@@ -68,6 +68,16 @@ public final class TwillContainerLauncher {
this.secureStoreLocation = secureStoreLocation;
}
+ /**
+ * Start execution run for a class in a container. Will return instance of {@link TwillContainerController}
+ * that allows sending messages directly to the container.
+ *
+ * @param runId Use to represent unique id of the container run.
+ * @param instanceId The Twill instance Id.
+ * @param mainClass The main class to run in the container.
+ * @param classPath The class path to load classes for the container.
+ * @return instance of {@link TwillContainerController} to control the container run.
+ */
public TwillContainerController start(RunId runId, int instanceId, Class<?> mainClass, String classPath) {
// Clean up zookeeper path in case this is a retry and there are old messages and state there.
Futures.getUnchecked(ZKOperations.ignoreError(
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/ca33245c/twill-core/src/main/java/org/apache/twill/internal/logging/KafkaAppender.java
----------------------------------------------------------------------
diff --git a/twill-core/src/main/java/org/apache/twill/internal/logging/KafkaAppender.java b/twill-core/src/main/java/org/apache/twill/internal/logging/KafkaAppender.java
index ff74677..1f8d02d 100644
--- a/twill-core/src/main/java/org/apache/twill/internal/logging/KafkaAppender.java
+++ b/twill-core/src/main/java/org/apache/twill/internal/logging/KafkaAppender.java
@@ -31,8 +31,8 @@ import com.google.common.util.concurrent.Service;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import org.apache.twill.api.logging.LogThrowable;
-import org.apache.twill.internal.Services;
import org.apache.twill.common.Threads;
+import org.apache.twill.internal.Services;
import org.apache.twill.internal.json.ILoggingEventSerializer;
import org.apache.twill.internal.json.LogThrowableCodec;
import org.apache.twill.internal.json.StackTraceElementCodec;
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/ca33245c/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAMClient.java
----------------------------------------------------------------------
diff --git a/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAMClient.java b/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAMClient.java
index c5ac458..82f428a 100644
--- a/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAMClient.java
+++ b/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAMClient.java
@@ -40,7 +40,7 @@ import java.util.List;
import javax.annotation.Nullable;
/**
- *
+ * Wrapper class for {@link AMRMClient} for Hadoop version 2.1 or greater.
*/
public class Hadoop21YarnAMClient extends AbstractYarnAMClient<AMRMClient.ContainerRequest> {
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/ca33245c/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnNMClient.java
----------------------------------------------------------------------
diff --git a/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnNMClient.java b/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnNMClient.java
index b8c9088..8c5f0fc 100644
--- a/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnNMClient.java
+++ b/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnNMClient.java
@@ -30,7 +30,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- *
+ * Wrapper class for {@link NMClient} for Hadoop version 2.1 or greater.
*/
public final class Hadoop21YarnNMClient extends AbstractIdleService implements YarnNMClient {
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/ca33245c/twill-yarn/src/main/java/org/apache/twill/internal/appmaster/ApplicationMasterService.java
----------------------------------------------------------------------
diff --git a/twill-yarn/src/main/java/org/apache/twill/internal/appmaster/ApplicationMasterService.java b/twill-yarn/src/main/java/org/apache/twill/internal/appmaster/ApplicationMasterService.java
index f248750..b85ce97 100644
--- a/twill-yarn/src/main/java/org/apache/twill/internal/appmaster/ApplicationMasterService.java
+++ b/twill-yarn/src/main/java/org/apache/twill/internal/appmaster/ApplicationMasterService.java
@@ -94,7 +94,7 @@ import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
/**
- *
+ * The class that acts as {@code ApplicationMaster} for Twill applications.
*/
public final class ApplicationMasterService extends AbstractYarnTwillService implements Supplier<ResourceReport> {
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/ca33245c/twill-yarn/src/main/java/org/apache/twill/internal/container/TwillContainerMain.java
----------------------------------------------------------------------
diff --git a/twill-yarn/src/main/java/org/apache/twill/internal/container/TwillContainerMain.java b/twill-yarn/src/main/java/org/apache/twill/internal/container/TwillContainerMain.java
index a29b27c..e04c8f9 100644
--- a/twill-yarn/src/main/java/org/apache/twill/internal/container/TwillContainerMain.java
+++ b/twill-yarn/src/main/java/org/apache/twill/internal/container/TwillContainerMain.java
@@ -58,7 +58,7 @@ import java.io.IOException;
import java.io.Reader;
/**
- *
+ * The main class for launching a {@link TwillContainerService}.
*/
public final class TwillContainerMain extends ServiceMain {