From d5c7e714d12c5534be725f2e1a67fd115536045f Mon Sep 17 00:00:00 2001
From: Lukas Eder <lukas.eder@gmail.com>
Date: Fri, 11 Jan 2013 11:17:12 +0100
Subject: [PATCH] [#2113] Document Record.hashCode() and equals() through
 Javadoc

---
 jOOQ/src/main/java/org/jooq/Record.java | 52 +++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/jOOQ/src/main/java/org/jooq/Record.java b/jOOQ/src/main/java/org/jooq/Record.java
index d5982961f4..fc806e34a5 100644
--- a/jOOQ/src/main/java/org/jooq/Record.java
+++ b/jOOQ/src/main/java/org/jooq/Record.java
@@ -861,6 +861,58 @@ public interface Record extends FieldProvider, Attachable, Comparable<Record> {
     // Inherited methods
     // -------------------------------------------------------------------------
 
+    /**
+     * Get a hash code of this <code>Record</code>, based on the underlying row
+     * value expression
+     * <p>
+     * In order to fulfill the general contract of {@link Object#hashCode()} and
+     * {@link Object#equals(Object)}, a <code>Record</code>'s hash code value
+     * depends on all hash code values of this <code>Record</code>'s underlying
+     * column values.
+     *
+     * @return A hash code value for this record
+     * @see #equals(Object)
+     */
+    @Override
+    int hashCode();
+
+    /**
+     * Compare this <code>Record</code> with another <code>Record</code> for
+     * equality.
+     * <p>
+     * Two records are considered equal if
+     * <ul>
+     * <li>They have the same degree</li>
+     * <li>For every <code>i BETWEEN 0 AND degree, r1[i] = r2[i]</code></li>
+     * </ul>
+     * <p>
+     * Note, that the above rules correspond to the SQL comparison predicate
+     * behaviour as illustrated in the following example: <code><pre>
+     * -- A row value expression comparison predicate
+     * SELECT *
+     * FROM my_table
+     * WHERE (1, 'A') = (1, 'A')
+     * </pre></code>
+     * <p>
+     * Unlike SQL, jOOQ allows to compare also incompatible records, e.g.
+     * records
+     * <ul>
+     * <li>... whose degrees are not equal (results in <code>false</code>)</li>
+     * <li>... whose column types are not equal (results in <code>false</code>)</li>
+     * <li>... whose record types are not equal (irrelevant for the result)</li>
+     * </ul>
+     * <p>
+     * It can be said that for all R1, R2, if <code>R1.equal(R2)</code>, then
+     * <code>R1.compareTo(R2) == 0</code>
+     *
+     * @param other The other record
+     * @return Whether the two records are equal
+     * @see #compareTo(Record)
+     * @see #hashCode()
+     */
+    @Override
+    boolean equals(Object other);
+
     /**
      * Compares this <code>Record</code> with another <code>Record</code>
      * according to their natural ordering.