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:45 UTC

[11/25] incubator-twill git commit: Add missing Javdoc for classes related to YarnAppClient.

Add missing Javdoc for classes related to YarnAppClient.

Oh and remove extra line in TwillController.

This closes #45 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/dc9320b5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-twill/tree/dc9320b5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-twill/diff/dc9320b5

Branch: refs/heads/site
Commit: dc9320b54d83fb5b63d5cc19707e53e686505d28
Parents: 7350f28
Author: hsaputra <hs...@apache.org>
Authored: Fri Jun 19 14:27:48 2015 -0700
Committer: Terence Yim <ch...@apache.org>
Committed: Mon Jun 22 16:02:28 2015 -0700

----------------------------------------------------------------------
 .../src/main/java/org/apache/twill/api/TwillController.java     | 1 -
 .../org/apache/twill/internal/yarn/Hadoop20YarnAppClient.java   | 5 +++++
 .../org/apache/twill/internal/yarn/Hadoop21YarnAppClient.java   | 5 +++++
 .../twill/internal/yarn/VersionDetectYarnAppClientFactory.java  | 2 +-
 4 files changed, 11 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/dc9320b5/twill-api/src/main/java/org/apache/twill/api/TwillController.java
----------------------------------------------------------------------
diff --git a/twill-api/src/main/java/org/apache/twill/api/TwillController.java b/twill-api/src/main/java/org/apache/twill/api/TwillController.java
index 65b9b2d..7d88bb7 100644
--- a/twill-api/src/main/java/org/apache/twill/api/TwillController.java
+++ b/twill-api/src/main/java/org/apache/twill/api/TwillController.java
@@ -41,7 +41,6 @@ public interface TwillController extends ServiceController {
    */
   ServiceDiscovered discoverService(String serviceName);
 
-
   /**
    * Changes the number of running instances of a given runnable.
    *

http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/dc9320b5/twill-yarn/src/main/hadoop20/org/apache/twill/internal/yarn/Hadoop20YarnAppClient.java
----------------------------------------------------------------------
diff --git a/twill-yarn/src/main/hadoop20/org/apache/twill/internal/yarn/Hadoop20YarnAppClient.java b/twill-yarn/src/main/hadoop20/org/apache/twill/internal/yarn/Hadoop20YarnAppClient.java
index dfe4e67..3afa49a 100644
--- a/twill-yarn/src/main/hadoop20/org/apache/twill/internal/yarn/Hadoop20YarnAppClient.java
+++ b/twill-yarn/src/main/hadoop20/org/apache/twill/internal/yarn/Hadoop20YarnAppClient.java
@@ -50,7 +50,12 @@ import java.util.List;
 import javax.annotation.Nullable;
 
 /**
+ * <p>
+ * The service implementation of {@link YarnAppClient} for Apache Hadoop 2.0.
  *
+ * The {@link VersionDetectYarnAppClientFactory} class will decide to return instance of this class for
+ * Apache Hadoop 2.0.
+ * </p>
  */
 public final class Hadoop20YarnAppClient extends AbstractIdleService implements YarnAppClient {
 

http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/dc9320b5/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAppClient.java
----------------------------------------------------------------------
diff --git a/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAppClient.java b/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAppClient.java
index ac126ce..046e3f1 100644
--- a/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAppClient.java
+++ b/twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAppClient.java
@@ -46,7 +46,12 @@ import java.util.List;
 import javax.annotation.Nullable;
 
 /**
+ * <p>
+ * The service implementation of {@link YarnAppClient} for Apache Hadoop 2.1 and beyond.
  *
+ * The {@link VersionDetectYarnAppClientFactory} class will decide to return instance of this class for
+ * Apache Hadoop 2.1 and beyond.
+ * </p>
  */
 public final class Hadoop21YarnAppClient extends AbstractIdleService implements YarnAppClient {
 

http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/dc9320b5/twill-yarn/src/main/java/org/apache/twill/internal/yarn/VersionDetectYarnAppClientFactory.java
----------------------------------------------------------------------
diff --git a/twill-yarn/src/main/java/org/apache/twill/internal/yarn/VersionDetectYarnAppClientFactory.java b/twill-yarn/src/main/java/org/apache/twill/internal/yarn/VersionDetectYarnAppClientFactory.java
index 04bd30d..9f6e8a1 100644
--- a/twill-yarn/src/main/java/org/apache/twill/internal/yarn/VersionDetectYarnAppClientFactory.java
+++ b/twill-yarn/src/main/java/org/apache/twill/internal/yarn/VersionDetectYarnAppClientFactory.java
@@ -21,7 +21,7 @@ import com.google.common.base.Throwables;
 import org.apache.hadoop.conf.Configuration;
 
 /**
- *
+ * Helper factory class to return the right instance of {@link YarnAppClient} based on Apache Hadoop version.
  */
 public final class VersionDetectYarnAppClientFactory implements YarnAppClientFactory {