aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
index 6bd105842..50d811862 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -245,9 +245,12 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * Set whether to include transient fields when reflectively comparing objects.
- * @param testRecursive whether to do a recursive test
+ * Set whether to test fields recursively, instead of using their equals method, when reflectively comparing objects.
+ * String objects, which cache a hash value, are automatically excluded from recursive testing.
+ * You may specify other exceptions by calling {@link #setBypassReflectionClasses(List)}.
+ * @param testRecursive whether to do a recursive test
* @return EqualsBuilder - used to chain calls.
+ * @see #setBypassReflectionClasses(List)
* @since 3.6
*/
public EqualsBuilder setTestRecursive(final boolean testRecursive) {
@@ -265,6 +268,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* your own set of classes here, remember to include {@code String} class, too.</p>
* @param bypassReflectionClasses classes to bypass reflection test
* @return EqualsBuilder - used to chain calls.
+ * @see #setTestRecursive(boolean)
* @since 3.8
*/
public EqualsBuilder setBypassReflectionClasses(final List<Class<?>> bypassReflectionClasses) {