YARN-11381. Fix CheckStyle.

Author: slfan1989

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/client/api/AppAdminClient.java

@@ -308,7 +308,7 @@ public abstract int actionUpgradeExpress(String appName, File fileName)
    *
    * @param appName the name of the application
    * @return exit code
-   * @throws IOException
+   * @throws IOException io error occur.
    * @throws YarnException
    */
   @Public

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/client/api/TimelineClient.java

@@ -114,7 +114,7 @@ public abstract TimelinePutResponse putEntities(
    * 
    * @param domain
    *          an {@link TimelineDomain} object
-   * @throws IOException
+   * @throws IOException io error occur.
    * @throws YarnException
    */
   @Public
@@ -133,7 +133,7 @@ public abstract void putDomain(
    * @param domain
    *          an {@link TimelineDomain} object
    * @param appAttemptId {@link ApplicationAttemptId}
-   * @throws IOException
+   * @throws IOException io error occur.
    * @throws YarnException
    */
   @Public
@@ -151,7 +151,7 @@ public abstract void putDomain(ApplicationAttemptId appAttemptId,
    *          securely talking to the timeline server
    * @return a delegation token ({@link Token}) that can be used to talk to the
    *         timeline server
-   * @throws IOException
+   * @throws IOException io error occur.
    * @throws YarnException
    */
   @Public
@@ -166,7 +166,7 @@ public abstract Token<TimelineDelegationTokenIdentifier> getDelegationToken(
    * @param timelineDT
    *          the delegation token to renew
    * @return the new expiration time
-   * @throws IOException
+   * @throws IOException io error occur.
    * @throws YarnException
    */
   @Public
@@ -181,7 +181,7 @@ public abstract long renewDelegationToken(
    * 
    * @param timelineDT
    *          the delegation token to cancel
-   * @throws IOException
+   * @throws IOException io error occur.
    * @throws YarnException
    */
   @Public

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/client/api/TimelineReaderClient.java

@@ -59,7 +59,7 @@ public TimelineReaderClient(String name) {
    * @param fields Fields to be fetched. Defaults to INFO.
    * @param filters Filters to be applied while fetching entities.
    * @return entity of the application
-   * @throws IOException
+   * @throws IOException io error occur.
    */
   public abstract  TimelineEntity getApplicationEntity(
       ApplicationId appId, String fields, Map<String, String> filters)
@@ -71,7 +71,7 @@ public abstract  TimelineEntity getApplicationEntity(
    * @param fields Fields to be fetched. Defaults to INFO.
    * @param filters Filters to be applied while fetching entities.
    * @return entity associated with application attempt
-   * @throws IOException
+   * @throws IOException io error occur.
    */
   public abstract  TimelineEntity getApplicationAttemptEntity(
       ApplicationAttemptId appAttemptId, String fields,
@@ -85,7 +85,7 @@ public abstract  TimelineEntity getApplicationAttemptEntity(
    * @param limit Number of entities to return.
    * @param fromId Retrieve next set of generic ids from given fromId
    * @return list of application attempt entities
-   * @throws IOException
+   * @throws IOException io error occur.
    */
   public abstract  List<TimelineEntity> getApplicationAttemptEntities(
       ApplicationId appId, String fields, Map<String, String> filters,
@@ -97,7 +97,7 @@ public abstract  List<TimelineEntity> getApplicationAttemptEntities(
    * @param fields Fields to be fetched. Defaults to INFO.
    * @param filters Filters to be applied while fetching entities.
    * @return timeline entity for container
-   * @throws IOException
+   * @throws IOException io error occur.
    */
   public abstract  TimelineEntity getContainerEntity(
       ContainerId containerId, String fields, Map<String, String> filters)
@@ -111,7 +111,7 @@ public abstract  TimelineEntity getContainerEntity(
    * @param limit Number of entities to return.
    * @param fromId Retrieve next set of generic ids from given fromId
    * @return list of entities
-   * @throws IOException
+   * @throws IOException io error occur.
    */
   public abstract List<TimelineEntity> getContainerEntities(
       ApplicationId appId, String fields,

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/AttributeValue.java

@@ -35,7 +35,7 @@ public interface AttributeValue {
    * operations.
    *
    * @param value
-   * @throws IOException
+   * @throws IOException io error occur.
    */
   void validateAndInitializeValue(String value) throws IOException;
 

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/Apps.java

@@ -257,6 +257,10 @@ public static void addToEnvironment(
    * This older version of this method is kept around for compatibility
    * because downstream frameworks like Spark and Tez have been using it.
    * Downstream frameworks are expected to move off of it.
+   *
+   * @param environment
+   * @param variable
+   * @param value
    */
   @Deprecated
   public static void addToEnvironment(

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/ConverterUtils.java

@@ -57,7 +57,8 @@ public class ConverterUtils {
    * @param url
    *          url to convert
    * @return path from {@link URL}
-   * @throws URISyntaxException
+   * @throws URISyntaxException exception thrown to indicate that a string could not be parsed as a
+   * URI reference.
    */
   @Public
   @Deprecated
@@ -171,6 +172,7 @@ public static ApplicationId toApplicationId(
    *
    * @param protoToken the yarn token
    * @param serviceAddr the connect address for the service
+   * @param <T> Generic Type T.
    * @return rpc token
    */
   public static <T extends TokenIdentifier> Token<T> convertFromYarn(
@@ -191,6 +193,8 @@ public static <T extends TokenIdentifier> Token<T> convertFromYarn(
    *
    * @param protoToken the yarn token
    * @param service the service for the token
+   * @param <T> Generic Type T.
+   * @return rpc token
    */
   public static <T extends TokenIdentifier> Token<T> convertFromYarn(
       org.apache.hadoop.yarn.api.records.Token protoToken,

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/DockerClientConfigHandler.java

@@ -131,6 +131,7 @@ public static Credentials readCredentialsFromConfigFile(Path configFile,
    *
    * @param tokens the Tokens from the ContainerLaunchContext.
    * @return the Credentials object populated from the Tokens.
+   * @throws IOException io error occur.
    */
   public static Credentials getCredentialsFromTokensByteBuffer(
       ByteBuffer tokens) throws IOException {

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/FSDownload.java

@@ -123,10 +123,13 @@ private void createDir(Path path, FsPermission perm) throws IOException {
    * Creates the cache loader for the status loading cache. This should be used
    * to create an instance of the status cache that is passed into the
    * FSDownload constructor.
+   *
+   * @param conf configuration.
+   * @return cache loader for the status loading cache.
    */
-  public static CacheLoader<Path,Future<FileStatus>>
+  public static CacheLoader<Path, Future<FileStatus>>
       createStatusCacheLoader(final Configuration conf) {
-    return new CacheLoader<Path,Future<FileStatus>>() {
+    return new CacheLoader<Path, Future<FileStatus>>() {
       public Future<FileStatus> load(Path path) {
         try {
           FileSystem fs = path.getFileSystem(conf);
@@ -141,10 +144,15 @@ public Future<FileStatus> load(Path path) {
 
   /**
    * Returns a boolean to denote whether a cache file is visible to all (public)
-   * or not
+   * or not.
    *
+   * @param fs fileSystem.
+   * @param current current path.
+   * @param sStat file status.
+   * @param statCache stat cache.
    * @return true if the path in the current path is visible to all, false
    * otherwise
+   * @throws IOException io error occur.
    */
   @Private
   public static boolean isPublic(FileSystem fs, Path current, FileStatus sStat,
@@ -455,7 +463,7 @@ public Void run() throws Exception {
    * Change to 755 or 700 for dirs, 555 or 500 for files.
    * @param fs FileSystem
    * @param path Path to modify perms for
-   * @throws IOException
+   * @throws IOException io error occur.
    * @throws InterruptedException 
    */
   private void changePermissions(FileSystem fs, final Path path)

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/ProcfsBasedProcessTree.java

@@ -579,6 +579,9 @@ public String toString() {
 /**
  * Returns boolean indicating whether pid
  * is in process tree.
+ *
+ * @param pid pid.
+ * @return if true, processTree contains pid, false, processTree does not contain pid.
  */
   public boolean contains(String pid) {
     return processTree.containsKey(pid);
@@ -1000,9 +1003,9 @@ public String toString() {
   }
 
   /**
-   * Test the {@link ProcfsBasedProcessTree}
+   * Test the {@link ProcfsBasedProcessTree}.
    *
-   * @param args
+   * @param args the pid arg.
    */
   public static void main(String[] args) {
     if (args.length != 1) {

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/RackResolver.java

@@ -79,8 +79,8 @@ public synchronized static void init(Configuration conf) {
    * Utility method for getting a hostname resolved to a node in the
    * network topology. This method initializes the class with the
    * right resolver implementation.
-   * @param conf
-   * @param hostName
+   * @param conf configuration.
+   * @param hostName hostname.
    * @return node {@link Node} after resolving the hostname
    */
   public static Node resolve(Configuration conf, String hostName) {
@@ -92,8 +92,8 @@ public static Node resolve(Configuration conf, String hostName) {
    * Utility method for getting a list of hostname resolved to a list of node
    *  in the network topology. This method initializes the class with the
    * right resolver implementation.
-   * @param conf
-   * @param hostNames
+   * @param conf configuration.
+   * @param hostNames list of hostName.
    * @return nodes {@link Node} after resolving the hostnames
    */
   public static List<Node> resolve(
@@ -106,7 +106,7 @@ public static List<Node> resolve(
    * Utility method for getting a hostname resolved to a node in the
    * network topology. This method doesn't initialize the class.
    * Call {@link #init(Configuration)} explicitly.
-   * @param hostName
+   * @param hostName host name.
    * @return node {@link Node} after resolving the hostname
    */
   public static Node resolve(String hostName) {
@@ -120,7 +120,7 @@ public static Node resolve(String hostName) {
    * Utility method for getting a list of hostname resolved to a list of node
    *  in the network topology. This method doesn't initialize the class.
    * Call {@link #init(Configuration)} explicitly.
-   * @param hostNames
+   * @param hostNames list of hostNames.
    * @return nodes {@link Node} after resolving the hostnames
    */
   public static List<Node> resolve(List<String> hostNames) {