Skip to content

Commit a63141a

Browse files
committed
Add missing @param javadoc on AllocationRejection.wrap(Runnable) overload
The Runnable overload of AllocationRejection.wrap was missing @param tags for context and body, failing the missingJavadoc gradle-check on CI: AllocationRejection.java:75: error: AllocationRejection.wrap (method): missing javadoc @param for parameter 'context' Mirror the @param/@throws structure already present on the Supplier overload above. Signed-off-by: Gaurav Singh <snghsvn@amazon.com>
1 parent f4cbdd2 commit a63141a

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

plugins/arrow-base/src/main/java/org/opensearch/arrow/allocator/AllocationRejection.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,13 @@ public static <T> T wrap(String context, Supplier<T> body) {
7171
* Runs {@code body} and translates any Arrow {@link OutOfMemoryException}
7272
* into {@link OpenSearchRejectedExecutionException}. Use this overload for
7373
* void allocation sites.
74+
*
75+
* @param context short label included in the rejection message (typically the
76+
* pool or operation name; e.g. "query-pool", "ingest-vsr")
77+
* @param body the allocation site to invoke
78+
* @throws OpenSearchRejectedExecutionException if {@code body} throws
79+
* {@link OutOfMemoryException}; the original Arrow exception is
80+
* attached as the cause
7481
*/
7582
public static void wrap(String context, Runnable body) {
7683
try {

0 commit comments

Comments
 (0)