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:16 UTC
[1/8] [lang] Reference constants in a non static way to align the
retention value with the target value.
Repository: commons-lang
Updated Branches:
refs/heads/master 60b32953a -> d2b1e522b
Reference constants in a non static way to align the retention value with the target value.
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/37c20df7
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/37c20df7
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/37c20df7
Branch: refs/heads/master
Commit: 37c20df721522b175bc9df3f06a361297010df5e
Parents: 8548b12
Author: Benedikt Ritter <br...@apache.org>
Authored: Mon May 4 20:58:47 2015 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Mon May 4 20:58:47 2015 +0200
----------------------------------------------------------------------
.../java/org/apache/commons/lang3/builder/EqualsExclude.java | 4 ++--
.../java/org/apache/commons/lang3/builder/HashCodeExclude.java | 4 ++--
.../java/org/apache/commons/lang3/builder/ToStringExclude.java | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/37c20df7/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 f71616f..52edebb 100755
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
@@ -19,13 +19,13 @@ package org.apache.commons.lang3.builder;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Use this annotation to builds a equals excluding the annotated field.
*/
-@Retention(RUNTIME)
+@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface EqualsExclude {
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/37c20df7/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
index adc2eb4..369f0bc 100755
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
@@ -19,13 +19,13 @@ package org.apache.commons.lang3.builder;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Use this annotation to builds a hash code excluding the annotated field.
*/
-@Retention(RUNTIME)
+@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface HashCodeExclude {
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/37c20df7/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java b/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java
index 0e26c49..4b73599 100755
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java
@@ -20,12 +20,12 @@ package org.apache.commons.lang3.builder;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
-import static java.lang.annotation.RetentionPolicy.RUNTIME;
+import java.lang.annotation.RetentionPolicy;
/**
* Use this annotation to builds a String excluding the annotated field.
*/
-@Retention(RUNTIME)
+@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ToStringExclude {
[3/8] [lang] Better JavaDoc for HashCodeExclude
Posted by br...@apache.org.
Better JavaDoc for HashCodeExclude
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/0e67448f
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/0e67448f
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/0e67448f
Branch: refs/heads/master
Commit: 0e67448f8b7d6a3b606d6c6d31574ed5329271f9
Parents: 758f567
Author: Benedikt Ritter <br...@apache.org>
Authored: Mon May 4 21:12:20 2015 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Mon May 4 21:13:47 2015 +0200
----------------------------------------------------------------------
.../commons/lang3/builder/HashCodeBuilder.java | 15 +++++++++++++++
.../commons/lang3/builder/HashCodeExclude.java | 4 +++-
2 files changed, 18 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/0e67448f/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
index fbbd110..a2956a5 100644
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
@@ -94,6 +94,9 @@ import org.apache.commons.lang3.Validate;
* return HashCodeBuilder.reflectionHashCode(this);
* }
* </pre>
+ *
+ * <p>The {@link HashCodeExclude} annotation can be used to exclude fields from being
+ * used by the <code>reflectionHashCode</code> methods.</p>
*
* @since 1.0
* @version $Id$
@@ -246,6 +249,8 @@ public class HashCodeBuilder implements Builder<Integer> {
* if the Object is <code>null</code>
* @throws IllegalArgumentException
* if the number is zero or even
+ *
+ * @see HashCodeExclude
*/
public static int reflectionHashCode(final int initialNonZeroOddNumber, final int multiplierNonZeroOddNumber, final Object object) {
return reflectionHashCode(initialNonZeroOddNumber, multiplierNonZeroOddNumber, object, false, null);
@@ -290,6 +295,8 @@ public class HashCodeBuilder implements Builder<Integer> {
* if the Object is <code>null</code>
* @throws IllegalArgumentException
* if the number is zero or even
+ *
+ * @see HashCodeExclude
*/
public static int reflectionHashCode(final int initialNonZeroOddNumber, final int multiplierNonZeroOddNumber, final Object object,
final boolean testTransients) {
@@ -342,6 +349,8 @@ public class HashCodeBuilder implements Builder<Integer> {
* if the Object is <code>null</code>
* @throws IllegalArgumentException
* if the number is zero or even
+ *
+ * @see HashCodeExclude
* @since 2.0
*/
public static <T> int reflectionHashCode(final int initialNonZeroOddNumber, final int multiplierNonZeroOddNumber, final T object,
@@ -392,6 +401,8 @@ public class HashCodeBuilder implements Builder<Integer> {
* @return int hash code
* @throws IllegalArgumentException
* if the object is <code>null</code>
+ *
+ * @see HashCodeExclude
*/
public static int reflectionHashCode(final Object object, final boolean testTransients) {
return reflectionHashCode(DEFAULT_INITIAL_VALUE, DEFAULT_MULTIPLIER_VALUE, object,
@@ -430,6 +441,8 @@ public class HashCodeBuilder implements Builder<Integer> {
* @return int hash code
* @throws IllegalArgumentException
* if the object is <code>null</code>
+ *
+ * @see HashCodeExclude
*/
public static int reflectionHashCode(final Object object, final Collection<String> excludeFields) {
return reflectionHashCode(object, ReflectionToStringBuilder.toNoNullStringArray(excludeFields));
@@ -469,6 +482,8 @@ public class HashCodeBuilder implements Builder<Integer> {
* @return int hash code
* @throws IllegalArgumentException
* if the object is <code>null</code>
+ *
+ * @see HashCodeExclude
*/
public static int reflectionHashCode(final Object object, final String... excludeFields) {
return reflectionHashCode(DEFAULT_INITIAL_VALUE, DEFAULT_MULTIPLIER_VALUE, object, false,
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/0e67448f/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
index 369f0bc..25bac4c 100755
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
@@ -23,7 +23,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Use this annotation to builds a hash code excluding the annotated field.
+ * Use this annotation to exclude a field from being being used by
+ * the various <code>reflectionHashcode</code> methods defined on
+ * {@link HashCodeBuilder}.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
[7/8] [lang] Better field and constant names
Posted by br...@apache.org.
Better field and constant names
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/cae70c10
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/cae70c10
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/cae70c10
Branch: refs/heads/master
Commit: cae70c10b4451ee3b919764f72dc4a4caf0f6f27
Parents: ea1a69d
Author: Benedikt Ritter <br...@apache.org>
Authored: Mon May 4 21:45:14 2015 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Mon May 4 21:45:14 2015 +0200
----------------------------------------------------------------------
...oStringBuilderExcludeWithAnnotationTest.java | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/cae70c10/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java b/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
index f4330a1..58946cf 100755
--- a/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
+++ b/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
@@ -31,28 +31,28 @@ public class ReflectionToStringBuilderExcludeWithAnnotationTest {
class TestFixture {
@ToStringExclude
- private final String secretField = SECRET_VALUE;
+ private final String excludedField = EXCLUDED_FIELD_VALUE;
@SuppressWarnings("unused")
- private final String showField = NOT_SECRET_VALUE;
+ private final String includedField = INCLUDED_FIELD_VALUE;
}
- private static final String NOT_SECRET_FIELD = "showField";
+ private static final String INCLUDED_FIELD_NAME = "includedField";
- private static final String NOT_SECRET_VALUE = "Hello World!";
+ private static final String INCLUDED_FIELD_VALUE = "Hello World!";
- private static final String SECRET_FIELD = "secretField";
+ private static final String EXCLUDED_FIELD_NAME = "excludedField";
- private static final String SECRET_VALUE = "secret value";
+ private static final String EXCLUDED_FIELD_VALUE = "excluded field value";
@Test
public void test_toStringExclude() {
final String toString = ReflectionToStringBuilder.toString(new TestFixture());
- assertThat(toString, not(containsString(SECRET_FIELD)));
- assertThat(toString, not(containsString(SECRET_VALUE)));
- assertThat(toString, containsString(NOT_SECRET_FIELD));
- assertThat(toString, containsString(NOT_SECRET_VALUE));
+ assertThat(toString, not(containsString(EXCLUDED_FIELD_NAME)));
+ assertThat(toString, not(containsString(EXCLUDED_FIELD_VALUE)));
+ assertThat(toString, containsString(INCLUDED_FIELD_NAME));
+ assertThat(toString, containsString(INCLUDED_FIELD_VALUE));
}
}
[8/8] [lang] Merge branch 'LANG-1031-cleanup'
Posted by br...@apache.org.
Merge branch 'LANG-1031-cleanup'
Some cleanups following the integration of LANG-1031 (PR #77 from github)
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/d2b1e522
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/d2b1e522
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/d2b1e522
Branch: refs/heads/master
Commit: d2b1e522bffbfd983ea0061f1d5408fc98ebd8a5
Parents: 60b3295 cae70c1
Author: Benedikt Ritter <br...@apache.org>
Authored: Mon May 4 21:46:12 2015 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Mon May 4 21:46:12 2015 +0200
----------------------------------------------------------------------
.../commons/lang3/builder/EqualsBuilder.java | 11 +++++++
.../commons/lang3/builder/EqualsExclude.java | 8 +++--
.../commons/lang3/builder/HashCodeBuilder.java | 15 +++++++++
.../commons/lang3/builder/HashCodeExclude.java | 8 +++--
.../builder/ReflectionToStringBuilder.java | 14 +++++++++
.../commons/lang3/builder/ToStringExclude.java | 7 +++--
...oStringBuilderExcludeWithAnnotationTest.java | 32 +++++++++-----------
7 files changed, 68 insertions(+), 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/d2b1e522/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
----------------------------------------------------------------------
[5/8] [lang] Inline unnecessary local methods
Posted by br...@apache.org.
Inline unnecessary local methods
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/f175a241
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/f175a241
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/f175a241
Branch: refs/heads/master
Commit: f175a241c811d2d0843026b2dde5c3ae308cfb95
Parents: f24344c
Author: Benedikt Ritter <br...@apache.org>
Authored: Mon May 4 21:37:51 2015 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Mon May 4 21:37:51 2015 +0200
----------------------------------------------------------------------
...eflectionToStringBuilderExcludeWithAnnotationTest.java | 10 ++--------
1 file changed, 2 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/f175a241/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java b/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
index f6b62bc..acf7c2c 100755
--- a/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
+++ b/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
@@ -46,17 +46,11 @@ public class ReflectionToStringBuilderExcludeWithAnnotationTest {
@Test
public void test_toStringExclude() {
final String toString = ReflectionToStringBuilder.toString(new TestFixture());
- this.validateSecretFieldAbsent(toString);
- }
- private void validateNonSecretField(final String toString) {
+ Assert.assertEquals(ArrayUtils.INDEX_NOT_FOUND, toString.indexOf(SECRET_FIELD));
+ Assert.assertEquals(ArrayUtils.INDEX_NOT_FOUND, toString.indexOf(SECRET_VALUE));
Assert.assertTrue(toString.indexOf(NOT_SECRET_FIELD) > ArrayUtils.INDEX_NOT_FOUND);
Assert.assertTrue(toString.indexOf(NOT_SECRET_VALUE) > ArrayUtils.INDEX_NOT_FOUND);
}
- private void validateSecretFieldAbsent(final String toString) {
- Assert.assertEquals(ArrayUtils.INDEX_NOT_FOUND, toString.indexOf(SECRET_FIELD));
- Assert.assertEquals(ArrayUtils.INDEX_NOT_FOUND, toString.indexOf(SECRET_VALUE));
- this.validateNonSecretField(toString);
- }
}
[4/8] [lang] Better JavaDoc for ToStringExclude
Posted by br...@apache.org.
Better JavaDoc for ToStringExclude
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/f24344c2
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/f24344c2
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/f24344c2
Branch: refs/heads/master
Commit: f24344c2578a829acdfec914db27a5bbe0fc09f7
Parents: 0e67448
Author: Benedikt Ritter <br...@apache.org>
Authored: Mon May 4 21:21:32 2015 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Mon May 4 21:21:32 2015 +0200
----------------------------------------------------------------------
.../lang3/builder/ReflectionToStringBuilder.java | 14 ++++++++++++++
.../apache/commons/lang3/builder/ToStringExclude.java | 3 ++-
2 files changed, 16 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/f24344c2/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
index 5904469..83dba01 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
@@ -79,6 +79,10 @@ import org.apache.commons.lang3.ClassUtils;
* }
* </pre>
* <p>
+ * Alternatively the {@link ToStringExclude} annotation can be used to exclude fields from being incorporated in the
+ * result.
+ * </p>
+ * <p>
* The exact format of the <code>toString</code> is determined by the {@link ToStringStyle} passed into the constructor.
* </p>
*
@@ -113,6 +117,8 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @return the String result
* @throws IllegalArgumentException
* if the Object is <code>null</code>
+ *
+ * @see ToStringExclude
*/
public static String toString(final Object object) {
return toString(object, null, false, false, null);
@@ -145,6 +151,8 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @return the String result
* @throws IllegalArgumentException
* if the Object or <code>ToStringStyle</code> is <code>null</code>
+ *
+ * @see ToStringExclude
*/
public static String toString(final Object object, final ToStringStyle style) {
return toString(object, style, false, false, null);
@@ -183,6 +191,8 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @return the String result
* @throws IllegalArgumentException
* if the Object is <code>null</code>
+ *
+ * @see ToStringExclude
*/
public static String toString(final Object object, final ToStringStyle style, final boolean outputTransients) {
return toString(object, style, outputTransients, false, null);
@@ -228,6 +238,8 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @return the String result
* @throws IllegalArgumentException
* if the Object is <code>null</code>
+ *
+ * @see ToStringExclude
* @since 2.1
*/
public static String toString(final Object object, final ToStringStyle style, final boolean outputTransients, final boolean outputStatics) {
@@ -279,6 +291,8 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @return the String result
* @throws IllegalArgumentException
* if the Object is <code>null</code>
+ *
+ * @see ToStringExclude
* @since 2.1
*/
public static <T> String toString(
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/f24344c2/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java b/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java
index 4b73599..c080e31 100755
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java
@@ -23,7 +23,8 @@ import java.lang.annotation.Target;
import java.lang.annotation.RetentionPolicy;
/**
- * Use this annotation to builds a String excluding the annotated field.
+ * Use this annotation to exclude a field from being being used by
+ * the {@link ReflectionToStringBuilder}.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
[6/8] [lang] Use hamcrest matchers for better readability of
assertions
Posted by br...@apache.org.
Use hamcrest matchers for better readability of assertions
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/ea1a69d6
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/ea1a69d6
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/ea1a69d6
Branch: refs/heads/master
Commit: ea1a69d638d97d5ffc451b32d240479357e02b0a
Parents: f175a24
Author: Benedikt Ritter <br...@apache.org>
Authored: Mon May 4 21:42:50 2015 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Mon May 4 21:42:50 2015 +0200
----------------------------------------------------------------------
...ctionToStringBuilderExcludeWithAnnotationTest.java | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/ea1a69d6/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java b/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
index acf7c2c..f4330a1 100755
--- a/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
+++ b/src/test/java/org/apache/commons/lang3/builder/ReflectionToStringBuilderExcludeWithAnnotationTest.java
@@ -17,8 +17,10 @@
package org.apache.commons.lang3.builder;
-import org.apache.commons.lang3.ArrayUtils;
-import org.junit.Assert;
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.not;
+import static org.junit.Assert.assertThat;
+
import org.junit.Test;
/**
@@ -47,10 +49,10 @@ public class ReflectionToStringBuilderExcludeWithAnnotationTest {
public void test_toStringExclude() {
final String toString = ReflectionToStringBuilder.toString(new TestFixture());
- Assert.assertEquals(ArrayUtils.INDEX_NOT_FOUND, toString.indexOf(SECRET_FIELD));
- Assert.assertEquals(ArrayUtils.INDEX_NOT_FOUND, toString.indexOf(SECRET_VALUE));
- Assert.assertTrue(toString.indexOf(NOT_SECRET_FIELD) > ArrayUtils.INDEX_NOT_FOUND);
- Assert.assertTrue(toString.indexOf(NOT_SECRET_VALUE) > ArrayUtils.INDEX_NOT_FOUND);
+ assertThat(toString, not(containsString(SECRET_FIELD)));
+ assertThat(toString, not(containsString(SECRET_VALUE)));
+ assertThat(toString, containsString(NOT_SECRET_FIELD));
+ assertThat(toString, containsString(NOT_SECRET_VALUE));
}
}
[2/8] [lang] Better JavaDoc for EqualsExclude
Posted by br...@apache.org.
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)