Javadoc

apache · Dec 10, 2024 · 23f0816 · 23f0816
1 parent f480345
commit 23f0816
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/main/java/org/apache/commons/lang3/tuple/Pair.java b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
@@ -228,9 +228,11 @@ public R getValue() {
 
     /**
      * Returns a suitable hash code.
+     * <p>
      * The hash code follows the definition in {@code Map.Entry}.
+     * </p>
      *
-     * @return the hash code
+     * @return the hash code.
      */
     @Override
     public int hashCode() {

diff --git a/src/main/java/org/apache/commons/lang3/tuple/Triple.java b/src/main/java/org/apache/commons/lang3/tuple/Triple.java
@@ -168,11 +168,15 @@ public boolean equals(final Object obj) {
 
     /**
      * Returns a suitable hash code.
+     * <p>
+     * The hash code is adapted from the definition in {@code Map.Entry}.
+     * </p>
      *
-     * @return the hash code
+     * @return the hash code.
      */
     @Override
     public int hashCode() {
+        // See Map.Entry API specification
         return Objects.hashCode(getLeft()) ^ Objects.hashCode(getMiddle()) ^ Objects.hashCode(getRight());
     }