commit 35f124b0c3ca08e71a4e214a14afa7e83502b9fa Author: Vinod Kumar Vavilapalli Date: Mon Jan 13 12:51:18 2014 -0800 Javadoc warnings. diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptReportResponse.java hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptReportResponse.java index 68f1634..8667ad4 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptReportResponse.java +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptReportResponse.java @@ -60,7 +60,7 @@ public static GetApplicationAttemptReportResponse newInstance( /** * Get the ApplicationAttemptReport for the application attempt. * - * @param ApplicationAttemptReport ApplicationAttemptReport for + * @param applicationAttemptReport ApplicationAttemptReport for * the application attempt */ @Public diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptsRequest.java hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptsRequest.java index b632b09..a32d390 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptsRequest.java +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptsRequest.java @@ -56,7 +56,7 @@ public static GetApplicationAttemptsRequest newInstance( /** * Set the ApplicationId of an application * - * @param ApplicationId ApplicationId of an application + * @param applicationId ApplicationId of an application */ @Public @Unstable diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerReportRequest.java hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerReportRequest.java index 6e6ce55..42e93df 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerReportRequest.java +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerReportRequest.java @@ -52,7 +52,7 @@ public static GetContainerReportRequest newInstance(ContainerId containerId) { /** * Set the ContainerId of the container * - * @param ContainerId + * @param containerId * ContainerId of the container */ @Public diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java index ebfd95a..019319e 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java @@ -126,7 +126,7 @@ public abstract ApplicationReport getApplicationReport(ApplicationId appId) * @throws IOException */ public abstract ApplicationAttemptReport getApplicationAttemptReport( - ApplicationAttemptId appAttemptId) throws YarnException, IOException; + ApplicationAttemptId applicationAttemptId) throws YarnException, IOException; /** *

@@ -140,7 +140,7 @@ public abstract ApplicationAttemptReport getApplicationAttemptReport( * @throws IOException */ public abstract List getApplicationAttempts( - ApplicationId appId) throws YarnException, IOException; + ApplicationId applicationId) throws YarnException, IOException; /** *

diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java index d173cdf..dd27a02 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java @@ -386,7 +386,7 @@ public abstract QueueInfo getQueueInfo(String queueName) throws YarnException, * @throws IOException */ public abstract ApplicationAttemptReport getApplicationAttemptReport( - ApplicationAttemptId appAttemptId) throws YarnException, IOException; + ApplicationAttemptId applicationAttemptId) throws YarnException, IOException; /** *

@@ -400,7 +400,7 @@ public abstract ApplicationAttemptReport getApplicationAttemptReport( * @throws IOException */ public abstract List getApplicationAttempts( - ApplicationId appId) throws YarnException, IOException; + ApplicationId applicationId) throws YarnException, IOException; /** *

diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryReader.java hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryReader.java index bd632d8..149f5ec 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryReader.java +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryReader.java @@ -37,17 +37,18 @@ /** * This method returns Application {@link ApplicationHistoryData} for the * specified {@link ApplicationId}. + * @param appId * * @return {@link ApplicationHistoryData} for the ApplicationId. - * @throws {@link IOException} + * @throws IOException */ ApplicationHistoryData getApplication(ApplicationId appId) throws IOException; /** * This method returns all Application {@link ApplicationHistoryData}s * - * @return map {@link ApplicationId, @link ApplicationHistoryData}s. - * @throws {@link IOException} + * @return map of {@link ApplicationId} to {@link ApplicationHistoryData}s. + * @throws IOException */ Map getAllApplications() throws IOException; @@ -56,9 +57,10 @@ * Application can have multiple application attempts * {@link ApplicationAttemptHistoryData}. This method returns the all * {@link ApplicationAttemptHistoryData}s for the Application. + * @param appId * * @return all {@link ApplicationAttemptHistoryData}s for the Application. - * @throws {@link IOException} + * @throws IOException */ Map getApplicationAttempts( ApplicationId appId) throws IOException; @@ -67,9 +69,9 @@ * This method returns {@link ApplicationAttemptHistoryData} for specified * {@link ApplicationId}. * - * @param {@link ApplicationAttemptId} + * @param appAttemptId {@link ApplicationAttemptId} * @return {@link ApplicationAttemptHistoryData} for ApplicationAttemptId - * @throws {@link IOException} + * @throws IOException */ ApplicationAttemptHistoryData getApplicationAttempt( ApplicationAttemptId appAttemptId) throws IOException; @@ -78,9 +80,9 @@ ApplicationAttemptHistoryData getApplicationAttempt( * This method returns {@link ContainerHistoryData} for specified * {@link ContainerId}. * - * @param {@link ContainerId} + * @param containerId {@link ContainerId} * @return {@link ContainerHistoryData} for ContainerId - * @throws {@link IOException} + * @throws IOException */ ContainerHistoryData getContainer(ContainerId containerId) throws IOException; @@ -88,21 +90,22 @@ ApplicationAttemptHistoryData getApplicationAttempt( * This method returns {@link ContainerHistoryData} for specified * {@link ApplicationAttemptId}. * - * @param {@link ApplicationAttemptId} + * @param appAttemptId {@link ApplicationAttemptId} * @return {@link ContainerHistoryData} for ApplicationAttemptId - * @throws {@link IOException} + * @throws IOException */ ContainerHistoryData getAMContainer(ApplicationAttemptId appAttemptId) throws IOException; /** - * This method returns Map{@link ContainerId,@link ContainerHistoryData} for - * specified {@link ApplicationAttemptId}. + * This method returns Map{@link ContainerId} to {@link ContainerHistoryData} + * for specified {@link ApplicationAttemptId}. * - * @param {@link ApplicationAttemptId} - * @return Map{@link ContainerId, @link ContainerHistoryData} for + * @param appAttemptId + * {@link ApplicationAttemptId} + * @return Map{@link ContainerId} to {@link ContainerHistoryData} for * ApplicationAttemptId - * @throws {@link IOException} + * @throws IOException */ Map getContainers( ApplicationAttemptId appAttemptId) throws IOException; diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryWriter.java hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryWriter.java index 46e83a1..b3cac94 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryWriter.java +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryWriter.java @@ -31,8 +31,9 @@ /** * It is the interface of writing the application history, exposing the methods - * of writing {@link ApplicationHistoryData}, - * {@link ApplicationAttemptHistoryData} and {@link ContainerHistoryData}. + * of writing {@link ApplicationStartData}, {@link ApplicationFinishData} + * {@link ApplicationAttemptStartData}, {@link ApplicationAttemptFinishData}, + * {@link ContainerStartData} and {@link ContainerFinishData}. */ @Private @Unstable diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ApplicationContext.java hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ApplicationContext.java index 6ac5d48..4b86b7b 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ApplicationContext.java +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ApplicationContext.java @@ -36,9 +36,10 @@ /** * This method returns Application {@link ApplicationReport} for the specified * {@link ApplicationId}. + * @param appId * * @return {@link ApplicationReport} for the ApplicationId. - * @throws {@link IOException} + * @throws IOException */ @Public @Unstable @@ -47,8 +48,8 @@ /** * This method returns all Application {@link ApplicationReport}s * - * @return map {@link ApplicationId, @link ApplicationReport}s. - * @throws {@link IOException} + * @return map of {@link ApplicationId} to {@link ApplicationReport}s. + * @throws IOException */ @Public @Unstable @@ -58,9 +59,10 @@ * Application can have multiple application attempts * {@link ApplicationAttemptReport}. This method returns the all * {@link ApplicationAttemptReport}s for the Application. + * @param appId * * @return all {@link ApplicationAttemptReport}s for the Application. - * @throws {@link IOException} + * @throws IOException */ @Public @Unstable @@ -71,9 +73,9 @@ * This method returns {@link ApplicationAttemptReport} for specified * {@link ApplicationId}. * - * @param {@link ApplicationAttemptId} + * @param appAttemptId {@link ApplicationAttemptId} * @return {@link ApplicationAttemptReport} for ApplicationAttemptId - * @throws {@link IOException} + * @throws IOException */ @Public @Unstable @@ -84,9 +86,9 @@ ApplicationAttemptReport getApplicationAttempt( * This method returns {@link ContainerReport} for specified * {@link ContainerId}. * - * @param {@link ContainerId} + * @param containerId {@link ContainerId} * @return {@link ContainerReport} for ContainerId - * @throws {@link IOException} + * @throws IOException */ @Public @Unstable @@ -96,9 +98,9 @@ ApplicationAttemptReport getApplicationAttempt( * This method returns {@link ContainerReport} for specified * {@link ApplicationAttemptId}. * - * @param {@link ApplicationAttemptId} + * @param appAttemptId {@link ApplicationAttemptId} * @return {@link ContainerReport} for ApplicationAttemptId - * @throws {@link IOException} + * @throws IOException */ @Public @Unstable @@ -106,13 +108,14 @@ ContainerReport getAMContainer(ApplicationAttemptId appAttemptId) throws IOException; /** - * This method returns Map{@link ContainerId,@link ContainerReport} for - * specified {@link ApplicationAttemptId}. + * This method returns Map of {@link ContainerId} to {@link ContainerReport} + * for specified {@link ApplicationAttemptId}. * - * @param {@link ApplicationAttemptId} - * @return Map{@link ContainerId, @link ContainerReport} for + * @param appAttemptId + * {@link ApplicationAttemptId} + * @return Map of {@link ContainerId} to {@link ContainerReport} for * ApplicationAttemptId - * @throws {@link IOException} + * @throws IOException */ @Public @Unstable