JavaDoc update

Author: robsunday

jmx-scraper/src/integrationTest/java/io/opentelemetry/contrib/jmxscraper/assertions/DataPointAttributes.java

@@ -17,20 +17,20 @@ public class DataPointAttributes {
   private DataPointAttributes() {}
 
   /**
-   * Create instance of matcher that will be used to check if data point attribute with given name
-   * has provided value.
+   * Create instance of matcher that should be used to check if data point attribute with given name
+   * has value identical to the one provided as a parameter (exact match).
    *
    * @param name name of the data point attribute to check
-   * @param value expected value of data point attribute
+   * @param value expected value of checked data point attribute
    * @return instance of matcher
    */
   public static AttributeMatcher attribute(String name, String value) {
     return new AttributeMatcher(name, value);
   }
 
   /**
-   * Create instance of matcher that will be used to check if data point attribute with given name
-   * exists. Any value of the attribute is considered as matching.
+   * Create instance of matcher that should be used to check if data point attribute with given name
+   * exists. Any value of the attribute is considered as matching (any value match).
    *
    * @param name name of the data point attribute to check
    * @return instance of matcher
@@ -40,14 +40,14 @@ public static AttributeMatcher attributeWithAnyValue(String name) {
   }
 
   /**
-   * Create a set of attribute matchers that will be used to verify set of data point attributes.
+   * Create a set of attribute matchers that should be used to verify set of data point attributes.
    *
    * @param attributes list of matchers to create set. It must contain matchers with unique names.
    * @return set of unique attribute matchers
    * @throws IllegalArgumentException if provided list contains two or more matchers with the same
    *     name.
    * @see MetricAssert#hasDataPointsWithAttributes(Set[]) for detailed description of the algorithm
-   *     of matching
+   *     used for matching
    */
   public static Set<AttributeMatcher> attributeSet(AttributeMatcher... attributes) {
     Set<AttributeMatcher> matcherSet = Arrays.stream(attributes).collect(Collectors.toSet());

jmx-scraper/src/integrationTest/java/io/opentelemetry/contrib/jmxscraper/assertions/MetricAssert.java

@@ -245,10 +245,11 @@ public final MetricAssert hasDataPointsWithOneAttribute(AttributeMatcher expecte
   }
 
   /**
-   * Verifies that every data point attributes set is matched exactly by one of the matcher sets provided.
-   * Also, each matcher set must match at least one data point attributes set.
-   * Data point attributes set is matched by matcher set if each attribute is matched by one matcher and
-   * each matcher matches one attribute.
+   * Verifies that every data point attributes set is matched exactly by one of the matcher sets
+   * provided. Also, each matcher set must match at least one data point attributes set. Data point
+   * attributes set is matched by matcher set if each attribute is matched by one matcher and each
+   * matcher matches one attribute. In other words: number of attributes is the same as number of
+   * matchers and there is 1:1 matching between them.
    *
    * @param attributeMatchers array of attribute matcher sets
    * @return this