added javadoc clarifying hashCode() requirements (#140)

eclipse-serializer · Sep 12, 2024 · 40ca4ba · 40ca4ba
1 parent 0c5c834
commit 40ca4ba
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/base/src/main/java/org/eclipse/serializer/collections/lazy/LazyHashMap.java b/base/src/main/java/org/eclipse/serializer/collections/lazy/LazyHashMap.java
@@ -37,6 +37,12 @@
  * This map implementation internally uses {@link Lazy} references internally,
  * to enable automatic partial loading of it's content.
  * <br><br>
+ * <b>
+ * This Map implementation requires the key objects to implement the hashCode()
+ * in a manner that guarantees consistent, identical hash values from one execution of an
+ * application to another execution of the same application.
+ * </b>
+ * <br><br>
  * Internally the key value pairs are kept in segments that are controlled by
  * {@link Lazy} references. The maxSegmentSize define the maximal desired number of
  * key / value pairs to be kept in a single segment. When loading data all elements of a segment

diff --git a/base/src/main/java/org/eclipse/serializer/collections/lazy/LazyHashSet.java b/base/src/main/java/org/eclipse/serializer/collections/lazy/LazyHashSet.java
@@ -22,6 +22,12 @@
 
 /**
  * Implementation of the {@code Set} interface, backed by a {@link LazyHashMap}
+ * <br><br>
+ * <b>
+ * This Set implementation requires the objects that are added to the set to implement the hashCode()
+ * in a manner that guarantees consistent, identical hash values from one execution of an
+ * application to another execution of the same application.
+ * </b>
  *
  * @param <T> Type of contained elements
  */