update javadoc of finish method (#44)

teragrep · Nov 4, 2024 · f50ded3 · f50ded3
1 parent 6d276be
commit f50ded3
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/main/scala/com/teragrep/functions/dpf_03/BloomFilterAggregator.scala b/src/main/scala/com/teragrep/functions/dpf_03/BloomFilterAggregator.scala
@@ -95,9 +95,10 @@ class BloomFilterAggregator(final val columnName: String,
   }
 
   /**
-   * Find best BloomFilter candidate for return
-   * @param buffer BloomFilterBuffer returned by reduce step
-   * @return best candidate by fpp being smaller than requested
+   * Write the final buffer filter into a byte array
+   *
+   * @param buffer resulting final bloom filter after aggregation process
+   * @return byte array of the final bloom filter
    */
   override def finish(buffer: BloomFilter): Array[Byte] = {
     val baos = new ByteArrayOutputStream()