[incubator-baremaps] 05/06: Improve the javadoc

[bc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

bchapuis pushed a commit to branch 681-handle-the-out-of-memory-errors
in repository https://gitbox.apache.org/repos/asf/incubator-baremaps.git

commit b075598d0ac63a6721a72aeaa258e3f3a2e1b786
Author: Bertil Chapuis <bc...@gmail.com>
AuthorDate: Tue Jul 4 23:12:04 2023 +0200

    Improve the javadoc
---
 .../org/apache/baremaps/database/collection/JaggedDataMap.java    | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/baremaps-core/src/main/java/org/apache/baremaps/database/collection/JaggedDataMap.java b/baremaps-core/src/main/java/org/apache/baremaps/database/collection/JaggedDataMap.java
index c6ab5574..d831e9fb 100644
--- a/baremaps-core/src/main/java/org/apache/baremaps/database/collection/JaggedDataMap.java
+++ b/baremaps-core/src/main/java/org/apache/baremaps/database/collection/JaggedDataMap.java
@@ -19,6 +19,12 @@ import java.util.concurrent.atomic.AtomicLong;
 import java.util.stream.IntStream;
 import org.apache.baremaps.stream.StreamUtils;
 
+/**
+ * A map that stores data in a jagged array, using the 40 leas significant bits of the key to index
+ * the array. The capacity of the map is 2^40, which is sufficient to store 1 trillion entries.
+ *
+ * @param <E>
+ */
 public class JaggedDataMap<E> extends DataMap<E> {
 
   private static final int L_BYTES = 8;
@@ -50,7 +56,7 @@ public class JaggedDataMap<E> extends DataMap<E> {
   private final AtomicLong size = new AtomicLong();
 
   /**
-   * Constructs a map.
+   * Constructs a jagged data map.
    *
    * @param values the values
    */