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

This commit is contained in:
Shane Kumpf 2018-09-12 15:12:28 -06:00
parent 02b9bfdf9e
commit 8e9afbfb66
6 changed files with 10 additions and 12 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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