Add comment on Map.equals.

Signed-off-by: currantw <[email protected]>
Bit-Quill · Feb 1, 2025 · a9f84da · a9f84da
1 parent ceac19b
commit a9f84da
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/core/src/main/java/org/opensearch/sql/data/model/ExprTupleValue.java b/core/src/main/java/org/opensearch/sql/data/model/ExprTupleValue.java
@@ -75,6 +75,12 @@ public boolean equal(ExprValue other) {
       return false;
     }
 
+    /**
+     * {@link Map#equals} returns true if the two maps' entry sets are equal, and works properly
+     * across all implementation of the {@link Map} interface. See {@link
+     * https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#equals-java.lang.Object-} for
+     * more details.
+     */
     return valueMap.equals(other.tupleValue());
   }