Repository: reef
Updated Branches:
  refs/heads/master dfc3f1e5b -> 01c0a89ee


[REEF-530] Add missing Javadoc comments/triage TODOs in reef-runtime-yarn

JIRA:
  [REEF-530](https://issues.apache.org/jira/browse/REEF-530)

Pull request:
  This closes #717


Project: http://git-wip-us.apache.org/repos/asf/reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/reef/commit/01c0a89e
Tree: http://git-wip-us.apache.org/repos/asf/reef/tree/01c0a89e
Diff: http://git-wip-us.apache.org/repos/asf/reef/diff/01c0a89e

Branch: refs/heads/master
Commit: 01c0a89ee2970b7c7ff026a4d2c1f423a6c1d7da
Parents: dfc3f1e
Author: Mariia Mykhailova <[email protected]>
Authored: Wed Dec 9 17:03:06 2015 -0800
Committer: Dongjoon Hyun <[email protected]>
Committed: Thu Dec 10 16:36:40 2015 +0900

----------------------------------------------------------------------
 lang/java/reef-runtime-yarn/pom.xml                      | 11 +++++++++++
 .../runtime/yarn/driver/DefaultRackNameFormatter.java    |  5 ++++-
 .../yarn/driver/JobSubmissionDirectoryProvider.java      |  1 -
 .../yarn/driver/JobSubmissionDirectoryProviderImpl.java  |  4 ++++
 .../reef/runtime/yarn/driver/YarnContainerManager.java   |  5 +++--
 .../runtime/yarn/driver/YarnContainerRequestHandler.java |  5 ++++-
 6 files changed, 26 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/reef/blob/01c0a89e/lang/java/reef-runtime-yarn/pom.xml
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-yarn/pom.xml 
b/lang/java/reef-runtime-yarn/pom.xml
index e89fb76..db1c06d 100644
--- a/lang/java/reef-runtime-yarn/pom.xml
+++ b/lang/java/reef-runtime-yarn/pom.xml
@@ -76,6 +76,17 @@ under the License.
                 </excludes>
             </resource>
         </resources>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-checkstyle-plugin</artifactId>
+                    <configuration>
+                        
<configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation>
+                    </configuration>
+                </plugin>
+            </plugins>
+        </pluginManagement>
     </build>
 
 </project>

http://git-wip-us.apache.org/repos/asf/reef/blob/01c0a89e/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/DefaultRackNameFormatter.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/DefaultRackNameFormatter.java
 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/DefaultRackNameFormatter.java
index 2f3a562..3973be6 100644
--- 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/DefaultRackNameFormatter.java
+++ 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/DefaultRackNameFormatter.java
@@ -26,13 +26,16 @@ import javax.inject.Inject;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+/**
+ * Default implementation of rack names formatter.
+ * Extracts rack name from host name, if possible.
+ */
 @Private
 @DriverSide
 public final class DefaultRackNameFormatter implements RackNameFormatter {
 
   private static final Logger LOG = 
Logger.getLogger(DefaultRackNameFormatter.class.getName());
 
-
   @Inject
   private DefaultRackNameFormatter() {
   }

http://git-wip-us.apache.org/repos/asf/reef/blob/01c0a89e/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProvider.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProvider.java
 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProvider.java
index 35d0048..c03a2e9 100644
--- 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProvider.java
+++ 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProvider.java
@@ -23,7 +23,6 @@ import org.apache.reef.tang.annotations.DefaultImplementation;
 
 /**
  * Provides path to job submission directory.
- *
  */
 @DefaultImplementation(JobSubmissionDirectoryProviderImpl.class)
 public interface JobSubmissionDirectoryProvider {

http://git-wip-us.apache.org/repos/asf/reef/blob/01c0a89e/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProviderImpl.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProviderImpl.java
 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProviderImpl.java
index 056bccb..feb3dde 100644
--- 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProviderImpl.java
+++ 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/JobSubmissionDirectoryProviderImpl.java
@@ -27,6 +27,10 @@ import javax.inject.Inject;
 import java.text.SimpleDateFormat;
 import java.util.Calendar;
 
+/**
+ * Default implementation of JobSubmissionDirectoryProvider.
+ * Constructs path to job submission directory based on current date and time 
and applicationId.
+ */
 public final class JobSubmissionDirectoryProviderImpl implements 
JobSubmissionDirectoryProvider {
 
   /**

http://git-wip-us.apache.org/repos/asf/reef/blob/01c0a89e/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java
 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java
index a069367..fc03393 100644
--- 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java
+++ 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java
@@ -424,7 +424,8 @@ final class YarnContainerManager
         // Therefore it is necessary avoid sending zero-container request, 
even it means getting extra containers.
         // It is okay to send nonzero m-capacity and n-capacity request 
together since bigger containers
         // can be matched.
-        // TODO: revisit this when implementing locality-strictness (i.e. a 
specific rack request can be ignored)
+        // TODO[JIRA REEF-42, REEF-942]: revisit this when implementing 
locality-strictness
+        // (i.e. a specific rack request can be ignored)
         if (this.requestsAfterSentToRM.size() > 1) {
           try {
             this.resourceManager.removeContainerRequest(matchedRequest);
@@ -488,7 +489,7 @@ final class YarnContainerManager
 
     final AMRMClient.ContainerRequest request = 
this.requestsAfterSentToRM.peek();
     final boolean resourceCondition = container.getResource().getMemory() >= 
request.getCapability().getMemory();
-    // TODO: check vcores once YARN-2380 is resolved
+    // TODO[JIRA REEF-35]: check vcores once YARN-2380 is resolved
     final boolean nodeCondition = request.getNodes() == null
         || request.getNodes().contains(container.getNodeId().getHost());
     final boolean rackCondition = request.getRacks() == null

http://git-wip-us.apache.org/repos/asf/reef/blob/01c0a89e/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerRequestHandler.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerRequestHandler.java
 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerRequestHandler.java
index 73c4b3b..359a505 100644
--- 
a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerRequestHandler.java
+++ 
b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerRequestHandler.java
@@ -21,12 +21,15 @@ package org.apache.reef.runtime.yarn.driver;
 import org.apache.hadoop.yarn.client.api.AMRMClient;
 import org.apache.reef.tang.annotations.DefaultImplementation;
 
+/**
+ * Interface to request containers from YARN using AMRMClient.ContainerRequest 
requests.
+ */
 @DefaultImplementation(YarnContainerRequestHandlerImpl.class)
 public interface YarnContainerRequestHandler {
   /**
    * Enqueue a set of container requests with YARN.
    *
-   * @param containerRequests
+   * @param containerRequests set of container requests
    */
   void onContainerRequest(final AMRMClient.ContainerRequest... 
containerRequests);
 }

Reply via email to