Skip to content

Commit 1265f3e

Browse files
authored
Added extra javadocs on getKeys and nonEmpty in BlockHash (#118357)
1 parent e3bddd0 commit 1265f3e

File tree

1 file changed

+6
-0
lines changed
  • x-pack/plugin/esql/compute/src/main/java/org/elasticsearch/compute/aggregation/blockhash

1 file changed

+6
-0
lines changed

x-pack/plugin/esql/compute/src/main/java/org/elasticsearch/compute/aggregation/blockhash/BlockHash.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ public abstract class BlockHash implements Releasable, SeenGroupIds {
9191

9292
/**
9393
* Returns a {@link Block} that contains all the keys that are inserted by {@link #add}.
94+
* <p>
95+
* Keys must be in the same order as the IDs returned by {@link #nonEmpty()}.
96+
* </p>
9497
*/
9598
public abstract Block[] getKeys();
9699

@@ -100,6 +103,9 @@ public abstract class BlockHash implements Releasable, SeenGroupIds {
100103
* {@link BooleanBlockHash} does this by always assigning {@code false} to {@code 0}
101104
* and {@code true} to {@code 1}. It's only <strong>after</strong> collection when we
102105
* know if there actually were any {@code true} or {@code false} values received.
106+
* <p>
107+
* IDs must be in the same order as the keys returned by {@link #getKeys()}.
108+
* </p>
103109
*/
104110
public abstract IntVector nonEmpty();
105111

0 commit comments

Comments
 (0)