YARN-2571 patch 016 fixup of final javadoc warnings, cleanup of <String> style definitions, and make sure public/private/evolving scope is everywhere appropriate, including package infos

Author: steveloughran

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/binding/JsonSerDeser.java

@@ -54,7 +54,7 @@
  * which use the mapper
  * @param <T> Type to marshal.
  */
-@InterfaceAudience.Private()
+@InterfaceAudience.Private
 @InterfaceStability.Evolving
 public class JsonSerDeser<T> {
 

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/binding/RegistryPathUtils.java

@@ -146,7 +146,7 @@ public static String join(String base, String path) {
   public static List<String> split(String path) {
     //
     String[] pathelements = path.split("/");
-    List<String> dirs = new ArrayList<String>(pathelements.length);
+    List<String> dirs = new ArrayList<>(pathelements.length);
     for (String pathelement : pathelements) {
       if (!pathelement.isEmpty()) {
         dirs.add(pathelement);

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/binding/RegistryTypeUtils.java

@@ -178,8 +178,8 @@ public static void requireAddressType(String required, Endpoint epr) throws
   /**
    * Get a single URI endpoint.
    * @param epr endpoint
-   * @return the uri of the first entry in the address list. Null if the endpoint
-   * itself is null
+   * @return the uri of the first entry in the address list.
+   * Null if the endpoint itself is null
    * @throws InvalidRecordException if the type is wrong, there are no addresses
    * or the payload ill-formatted
    */
@@ -194,7 +194,7 @@ public static List<String> retrieveAddressesUriType(Endpoint epr)
       throw new InvalidRecordException(epr.toString(),
           "No addresses in endpoint");
     }
-    List<String> results = new ArrayList<String>(addresses.size());
+    List<String> results = new ArrayList<>(addresses.size());
     for (Map<String, String> address : addresses) {
       results.add(getAddressField(address, ADDRESS_URI));
     }
@@ -232,7 +232,7 @@ public static List<URL> retrieveAddressURLs(Endpoint epr)
       throw new InvalidRecordException("", "Null endpoint");
     }
     List<String> addresses = retrieveAddressesUriType(epr);
-    List<URL> results = new ArrayList<URL>(addresses.size());
+    List<URL> results = new ArrayList<>(addresses.size());
     for (String address : addresses) {
       results.add(new URL(address));
     }

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/binding/RegistryUtils.java

@@ -204,7 +204,7 @@ public static Map<String, RegistryPathStatus> statChildren(
       IOException {
     List<String> childNames = registryOperations.list(path);
     Map<String, RegistryPathStatus> results =
-        new HashMap<String, RegistryPathStatus>();
+        new HashMap<>();
     for (String childName : childNames) {
       String child = join(path, childName);
       try {
@@ -313,7 +313,7 @@ public static Map<String, ServiceRecord> extractServiceRecords(
       RegistryOperations operations,
       String parentpath,
       Collection<RegistryPathStatus> stats) throws IOException {
-    Map<String, ServiceRecord> results = new HashMap<String, ServiceRecord>(stats.size());
+    Map<String, ServiceRecord> results = new HashMap<>(stats.size());
     for (RegistryPathStatus stat : stats) {
       if (stat.size > ServiceRecord.RECORD_TYPE.length()) {
         // maybe has data

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/exceptions/AuthenticationFailedException.java

@@ -18,10 +18,15 @@
 
 package org.apache.hadoop.registry.client.exceptions;
 
+import org.apache.hadoop.classification.InterfaceAudience;
+import org.apache.hadoop.classification.InterfaceStability;
+
 /**
  * Exception raised when client access wasn't authenticated.
  * That is: the credentials provided were incomplete or invalid.
  */
+@InterfaceAudience.Public
+@InterfaceStability.Evolving
 public class AuthenticationFailedException extends RegistryIOException {
   public AuthenticationFailedException(String path, Throwable cause) {
     super(path, cause);

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/exceptions/InvalidRecordException.java

@@ -23,7 +23,6 @@
 
 /**
  * Raised if an attempt to parse a record failed.
- *
  */
 @InterfaceAudience.Public
 @InterfaceStability.Evolving

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/exceptions/NoPathPermissionsException.java

@@ -18,13 +18,15 @@
 
 package org.apache.hadoop.registry.client.exceptions;
 
+import org.apache.hadoop.classification.InterfaceAudience;
+import org.apache.hadoop.classification.InterfaceStability;
 import org.apache.hadoop.fs.PathIOException;
 
 /**
  * Raised on path permission exceptions.
- * <p>
- * This is similar to PathIOException, except that exception doesn't let
  */
+@InterfaceAudience.Public
+@InterfaceStability.Evolving
 public class NoPathPermissionsException extends RegistryIOException {
   public NoPathPermissionsException(String path, Throwable cause) {
     super(path, cause);

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/exceptions/package-info.java

@@ -30,4 +30,9 @@
  *   All exceptions in this package are derived from
  *   {@link org.apache.hadoop.registry.client.exceptions.RegistryIOException}
  */
+@InterfaceAudience.Public
+@InterfaceStability.Evolving
 package org.apache.hadoop.registry.client.exceptions;
+
+import org.apache.hadoop.classification.InterfaceAudience;
+import org.apache.hadoop.classification.InterfaceStability;

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/CuratorService.java

@@ -297,8 +297,8 @@ protected String createFullPath(String path) throws IOException {
   }
 
   /**
-   * Get the registry binding source ... this can be used to
-   * create new ensemble providers
+   * Get the registry binding source; this can be used to
+   * create new ensemble providers.
    * @return the registry binding source in use
    */
   public RegistryBindingSource getBindingSource() {

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/RegistryBindingSource.java

@@ -22,14 +22,14 @@
 import org.apache.hadoop.classification.InterfaceStability;
 
 /**
- * Interface which can be implemented by a registry binding source
+ * Interface which can be implemented by a registry binding source.
  */
 @InterfaceAudience.Public
 @InterfaceStability.Evolving
 public interface RegistryBindingSource {
 
   /**
-   * Supply the binding information for this registry
+   * Supply the binding information for this registry.
    * @return the binding information data
    */
   BindingInformation supplyBindingInformation();