Sfoglia il codice sorgente

YARN-8768. Javadoc error in node attributes. Contributed by Sunil Govindan.

Shane Kumpf 6 anni fa
parent
commit
8e9afbfb66

+ 2 - 2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetAttributesToNodesRequest.java

@@ -56,7 +56,7 @@ public abstract class GetAttributesToNodesRequest {
    * Set node attributeKeys for which the mapping of hostname to attribute value
    * is required.
    *
-   * @param attributes Set<NodeAttributeKey> provided.
+   * @param attributes Set of NodeAttributeKey provided.
    */
   @Public
   @Unstable
@@ -66,7 +66,7 @@ public abstract class GetAttributesToNodesRequest {
    * Get node attributeKeys for which mapping of hostname to attribute value is
    * required.
    *
-   * @return Set<NodeAttributeKey>
+   * @return Set of NodeAttributeKey
    */
   @Public
   @Unstable

+ 1 - 2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetAttributesToNodesResponse.java

@@ -56,8 +56,7 @@ public abstract class GetAttributesToNodesResponse {
    * Get mapping of NodeAttributeKey to its associated mapping of list of
    * NodeToAttributeValue associated with attribute.
    *
-   * @return Map<NodeAttributeKey, List<NodeToAttributeValue>> node attributes
-   *         to list of NodeToAttributeValuenode.
+   * @return Map of node attributes to list of NodeToAttributeValue.
    */
   @Public
   @Evolving

+ 1 - 1
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetNodesToAttributesRequest.java

@@ -57,7 +57,7 @@ public abstract class GetNodesToAttributesRequest {
   /**
    * Get hostnames for which mapping is required.
    *
-   * @return Set<String> of hostnames.
+   * @return Set of hostnames.
    */
   @InterfaceAudience.Public
   @InterfaceStability.Evolving

+ 1 - 1
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetNodesToAttributesResponse.java

@@ -55,7 +55,7 @@ public abstract class GetNodesToAttributesResponse {
   /**
    * Get hostnames to NodeAttributes mapping.
    *
-   * @return Map<String, Set<NodeAttribute>> host to attributes.
+   * @return Map of host to attributes.
    */
   @Public
   @Evolving

+ 4 - 4
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/NodeAttributesManager.java

@@ -103,7 +103,7 @@ public abstract class NodeAttributesManager extends AbstractService {
   /**
    * NodeAttribute to AttributeValue Map.
    *
-   * @return Map<NodeAttribute, AttributeValue> mapping of Attribute to Value.
+   * @return Map of NodeAttribute to AttributeValue.
    */
   public abstract Map<NodeAttribute, AttributeValue> getAttributesForNode(
       String hostName);
@@ -111,7 +111,7 @@ public abstract class NodeAttributesManager extends AbstractService {
   /**
    * Get All node to Attributes list based on filter.
    *
-   * @return List<NodeToAttributes> nodeToAttributes matching filter.If empty
+   * @return List of NodeToAttributes matching filter. If empty
    * or null is passed as argument will return all.
    */
   public abstract List<NodeToAttributes> getNodeToAttributes(
@@ -120,8 +120,8 @@ public abstract class NodeAttributesManager extends AbstractService {
   /**
    * Get all node to Attributes mapping.
    *
-   * @return Map<String, Set<NodeAttribute>> nodesToAttributes matching
-   * filter.If empty or null is passed as argument will return all.
+   * @return Map of String to Set of nodesToAttributes matching
+   * filter. If empty or null is passed as argument will return all.
    */
   public abstract Map<String, Set<NodeAttribute>> getNodesToAttributes(
       Set<String> hostNames);

+ 1 - 2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/nodelabels/NodeAttributesManagerImpl.java

@@ -279,8 +279,7 @@ public class NodeAttributesManagerImpl extends NodeAttributesManager {
    * @param nodeAttributeMapping
    * @param newAttributesToBeAdded
    * @param isRemoveOperation : to indicate whether its a remove operation.
-   * @return Map<String, Map<NodeAttribute, AttributeValue>>, node -> Map(
-   *         NodeAttribute -> AttributeValue)
+   * @return Map of String to Map of NodeAttribute to AttributeValue
    * @throws IOException : on invalid mapping in the current request or against
    *           already existing NodeAttributes.
    */