You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by br...@apache.org on 2015/05/04 21:47:17 UTC
[2/8] [lang] Better JavaDoc for EqualsExclude
Better JavaDoc for EqualsExclude
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/758f5677
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/758f5677
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/758f5677
Branch: refs/heads/master
Commit: 758f5677a1f219f68ad0036b65498083efadb615
Parents: 37c20df
Author: Benedikt Ritter <br...@apache.org>
Authored: Mon May 4 21:06:30 2015 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Mon May 4 21:07:55 2015 +0200
----------------------------------------------------------------------
.../org/apache/commons/lang3/builder/EqualsBuilder.java | 11 +++++++++++
.../org/apache/commons/lang3/builder/EqualsExclude.java | 4 +++-
2 files changed, 14 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/758f5677/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
----------------------------------------------------------------------
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 be8f4f1..7551b0d 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -77,6 +77,9 @@ import org.apache.commons.lang3.tuple.Pair;
* return EqualsBuilder.reflectionEquals(this, obj);
* }
* </pre>
+ *
+ * <p>The {@link EqualsExclude} annotation can be used to exclude fields from being
+ * used by the <code>reflectionEquals</code> methods.</p>
*
* @since 1.0
* @version $Id$
@@ -245,6 +248,8 @@ public class EqualsBuilder implements Builder<Boolean> {
* @param rhs the other object
* @param excludeFields Collection of String field names to exclude from testing
* @return <code>true</code> if the two Objects have tested equals.
+ *
+ * @see EqualsExclude
*/
public static boolean reflectionEquals(final Object lhs, final Object rhs, final Collection<String> excludeFields) {
return reflectionEquals(lhs, rhs, ReflectionToStringBuilder.toNoNullStringArray(excludeFields));
@@ -269,6 +274,8 @@ public class EqualsBuilder implements Builder<Boolean> {
* @param rhs the other object
* @param excludeFields array of field names to exclude from testing
* @return <code>true</code> if the two Objects have tested equals.
+ *
+ * @see EqualsExclude
*/
public static boolean reflectionEquals(final Object lhs, final Object rhs, final String... excludeFields) {
return reflectionEquals(lhs, rhs, false, null, excludeFields);
@@ -294,6 +301,8 @@ public class EqualsBuilder implements Builder<Boolean> {
* @param rhs the other object
* @param testTransients whether to include transient fields
* @return <code>true</code> if the two Objects have tested equals.
+ *
+ * @see EqualsExclude
*/
public static boolean reflectionEquals(final Object lhs, final Object rhs, final boolean testTransients) {
return reflectionEquals(lhs, rhs, testTransients, null);
@@ -324,6 +333,8 @@ public class EqualsBuilder implements Builder<Boolean> {
* may be <code>null</code>
* @param excludeFields array of field names to exclude from testing
* @return <code>true</code> if the two Objects have tested equals.
+ *
+ * @see EqualsExclude
* @since 2.0
*/
public static boolean reflectionEquals(final Object lhs, final Object rhs, final boolean testTransients, final Class<?> reflectUpToClass,
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/758f5677/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java b/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
index 52edebb..1ed29f0 100755
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
@@ -23,7 +23,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Use this annotation to builds a equals excluding the annotated field.
+ * Use this annotation to exclude a field from being being used by
+ * the various <code>reflectionEquals</code> methods defined on
+ * {@link EqualsBuilder}.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)