Copilot commented on code in PR #16887:
URL: https://github.com/apache/pinot/pull/16887#discussion_r2377364473
##########
pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/groupby/GroupByResultHolder.java:
##########
@@ -68,6 +76,17 @@ public interface GroupByResultHolder {
*/
int getIntResult(int groupKey);
+ /**
+ * Returns the result (long) for the given group by key.
+ * If the group key does not exist in the result holder, returns
+ * the defaultValue it was initialized with (default value of the aggregation
+ * function it is holding the result for).
+ *
+ * @param groupKey
+ * @return
Review Comment:
The Javadoc is missing the parameter and return value descriptions. The
`@param groupKey` and `@return` tags should have descriptive text explaining
what they represent.
##########
pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/groupby/GroupByResultHolder.java:
##########
@@ -39,6 +39,14 @@ public interface GroupByResultHolder {
*/
void setValueForKey(int groupKey, int value);
+ /**
+ * Stores the given value (of type long) for the given groupKey.
+ *
+ * @param groupKey
+ * @param value
Review Comment:
The Javadoc parameter descriptions are missing. Both `@param groupKey` and
`@param value` should have descriptive text explaining what they represent.
##########
pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/AggregationResultHolder.java:
##########
@@ -36,6 +36,12 @@ public interface AggregationResultHolder {
*/
void setValue(int value);
+ /**
+ * Set the 'primitive long' aggregation result.
+ * @param value
Review Comment:
The Javadoc parameter description is missing. The `@param value` should have
descriptive text explaining what it represents.
```suggestion
* @param value The aggregation result as a primitive long value.
```
##########
pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/AggregationResultHolder.java:
##########
@@ -55,6 +61,13 @@ public interface AggregationResultHolder {
*/
int getIntResult();
+ /**
+ * Returns the 'primitive long' aggregation result.
+ *
+ * @return
Review Comment:
The Javadoc return description is missing. The `@return` tag should have
descriptive text explaining what the method returns.
```suggestion
* @return the 'primitive long' aggregation result
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
