This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new 30428e5f9 Javadoc
30428e5f9 is described below
commit 30428e5f991f25c2b54db9cb887f179ab0a0eeaa
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu May 23 09:14:30 2024 -0400
Javadoc
---
.../commons/lang3/builder/CompareToBuilder.java | 42 +++++-----
.../apache/commons/lang3/builder/DiffBuilder.java | 48 +++++------
.../commons/lang3/builder/EqualsBuilder.java | 50 +++++------
.../commons/lang3/builder/HashCodeBuilder.java | 38 ++++-----
.../lang3/builder/ReflectionDiffBuilder.java | 4 +-
.../lang3/builder/ReflectionToStringBuilder.java | 2 +-
.../commons/lang3/builder/ToStringBuilder.java | 98 +++++++++++-----------
.../concurrent/AbstractConcurrentInitializer.java | 4 +-
.../lang3/concurrent/BackgroundInitializer.java | 2 +-
.../org/apache/commons/lang3/text/StrBuilder.java | 4 +-
.../apache/commons/lang3/util/FluentBitSet.java | 42 +++++-----
11 files changed, 167 insertions(+), 167 deletions(-)
diff --git
a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
index e8f7020e2..0782e04ad 100644
--- a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
@@ -338,7 +338,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side value
* @param rhs right-hand side value
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final boolean lhs, final boolean rhs) {
if (comparison != 0) {
@@ -368,7 +368,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final boolean[] lhs, final boolean[] rhs) {
if (comparison != 0) {
@@ -401,7 +401,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side value
* @param rhs right-hand side value
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final byte lhs, final byte rhs) {
if (comparison != 0) {
@@ -424,7 +424,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final byte[] lhs, final byte[] rhs) {
if (comparison != 0) {
@@ -457,7 +457,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side value
* @param rhs right-hand side value
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final char lhs, final char rhs) {
if (comparison != 0) {
@@ -480,7 +480,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final char[] lhs, final char[] rhs) {
if (comparison != 0) {
@@ -518,7 +518,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side value
* @param rhs right-hand side value
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final double lhs, final double rhs) {
if (comparison != 0) {
@@ -541,7 +541,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final double[] lhs, final double[] rhs) {
if (comparison != 0) {
@@ -579,7 +579,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side value
* @param rhs right-hand side value
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final float lhs, final float rhs) {
if (comparison != 0) {
@@ -602,7 +602,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final float[] lhs, final float[] rhs) {
if (comparison != 0) {
@@ -635,7 +635,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side value
* @param rhs right-hand side value
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final int lhs, final int rhs) {
if (comparison != 0) {
@@ -658,7 +658,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final int[] lhs, final int[] rhs) {
if (comparison != 0) {
@@ -691,7 +691,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side value
* @param rhs right-hand side value
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final long lhs, final long rhs) {
if (comparison != 0) {
@@ -714,7 +714,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final long[] lhs, final long[] rhs) {
if (comparison != 0) {
@@ -756,7 +756,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side object
* @param rhs right-hand side object
- * @return this
+ * @return {@code this} instance.
* @throws ClassCastException if {@code rhs} is not assignment-compatible
* with {@code lhs}
*/
@@ -784,7 +784,7 @@ public class CompareToBuilder implements Builder<Integer> {
* @param rhs right-hand side object
* @param comparator {@link Comparator} used to compare the objects,
* {@code null} means treat lhs as {@link Comparable}
- * @return this
+ * @return {@code this} instance.
* @throws ClassCastException if {@code rhs} is not assignment-compatible
* with {@code lhs}
* @since 2.0
@@ -836,7 +836,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
* @throws ClassCastException if {@code rhs} is not assignment-compatible
* with {@code lhs}
*/
@@ -862,7 +862,7 @@ public class CompareToBuilder implements Builder<Integer> {
* @param rhs right-hand side array
* @param comparator {@link Comparator} to use to compare the array
elements,
* {@code null} means to treat {@code lhs} elements as {@link Comparable}.
- * @return this
+ * @return {@code this} instance.
* @throws ClassCastException if {@code rhs} is not assignment-compatible
* with {@code lhs}
* @since 2.0
@@ -898,7 +898,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side value
* @param rhs right-hand side value
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final short lhs, final short rhs) {
if (comparison != 0) {
@@ -921,7 +921,7 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand side array
* @param rhs right-hand side array
- * @return this
+ * @return {@code this} instance.
*/
public CompareToBuilder append(final short[] lhs, final short[] rhs) {
if (comparison != 0) {
@@ -980,7 +980,7 @@ public class CompareToBuilder implements Builder<Integer> {
* result of the superclass.
*
* @param superCompareTo result of calling {@code super.compareTo(Object)}
- * @return this
+ * @return {@code this} instance.
* @since 2.0
*/
public CompareToBuilder appendSuper(final int superCompareTo) {
diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
index ebd2fc98f..180ad959c 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
@@ -100,7 +100,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* Sets the left object.
*
* @param left the left object.
- * @return this.
+ * @return {@code this} instance.
*/
public Builder<T> setLeft(final T left) {
this.left = left;
@@ -111,7 +111,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* Sets the right object.
*
* @param right the left object.
- * @return this.
+ * @return {@code this} instance.
*/
public Builder<T> setRight(final T right) {
this.right = right;
@@ -122,7 +122,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* Sets the style will to use when outputting the objects, {@code
null} uses the default.
*
* @param style the style to use when outputting the objects, {@code
null} uses the default.
- * @return this.
+ * @return {@code this} instance.
*/
public Builder<T> setStyle(final ToStringStyle style) {
this.style = style != null ? style : ToStringStyle.DEFAULT_STYLE;
@@ -137,7 +137,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param testObjectsEquals If true, this will test if lhs and rhs are
the same or equal. All of the append(fieldName, left, right) methods will abort
* without creating a field {@link Diff} if
the trivially equal test is enabled and returns true. The result of this test is
* never changed throughout the life of this
{@link DiffBuilder}.
- * @return this.
+ * @return {@code this} instance.
*/
public Builder<T> setTestObjectsEquals(final boolean
testObjectsEquals) {
this.testObjectsEquals = testObjectsEquals;
@@ -148,7 +148,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* Sets the two-argument format string for {@link
String#format(String, Object...)}, for example {@code "%s differs from %s"}.
*
* @param toStringFormat {@code null} uses the default.
- * @return this.
+ * @return {@code this} instance.
*/
public Builder<T> setToStringFormat(final String toStringFormat) {
this.toStringFormat = toStringFormat != null ? toStringFormat :
TO_STRING_FORMAT;
@@ -267,7 +267,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code boolean}
* @param rhs the right-hand side {@code boolean}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final boolean lhs,
final boolean rhs) {
@@ -280,7 +280,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code boolean[]}
* @param rhs the right-hand side {@code boolean[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final boolean[] lhs,
final boolean[] rhs) {
@@ -293,7 +293,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code byte}
* @param rhs the right-hand side {@code byte}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final byte lhs, final
byte rhs) {
@@ -306,7 +306,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code byte[]}
* @param rhs the right-hand side {@code byte[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final byte[] lhs,
final byte[] rhs) {
@@ -319,7 +319,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code char}
* @param rhs the right-hand side {@code char}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final char lhs, final
char rhs) {
@@ -332,7 +332,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code char[]}
* @param rhs the right-hand side {@code char[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final char[] lhs,
final char[] rhs) {
@@ -364,7 +364,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
*
* @param fieldName the field name
* @param diffResult the {@link DiffResult} to append
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null} or
diffResult is {@code null}
* @since 3.5
*/
@@ -383,7 +383,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code double}
* @param rhs the right-hand side {@code double}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final double lhs,
final double rhs) {
@@ -397,7 +397,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code double[]}
* @param rhs the right-hand side {@code double[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final double[] lhs,
final double[] rhs) {
@@ -410,7 +410,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code float}
* @param rhs the right-hand side {@code float}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final float lhs,
final float rhs) {
@@ -424,7 +424,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code float[]}
* @param rhs the right-hand side {@code float[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final float[] lhs,
final float[] rhs) {
@@ -437,7 +437,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code int}
* @param rhs the right-hand side {@code int}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final int lhs, final
int rhs) {
@@ -450,7 +450,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code int[]}
* @param rhs the right-hand side {@code int[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final int[] lhs,
final int[] rhs) {
@@ -463,7 +463,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code long}
* @param rhs the right-hand side {@code long}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final long lhs, final
long rhs) {
@@ -476,7 +476,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code long[]}
* @param rhs the right-hand side {@code long[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final long[] lhs,
final long[] rhs) {
@@ -489,7 +489,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@link Object}
* @param rhs the right-hand side {@link Object}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final Object lhs,
final Object rhs) {
@@ -535,7 +535,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code Object[]}
* @param rhs the right-hand side {@code Object[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final Object[] lhs,
final Object[] rhs) {
@@ -548,7 +548,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code short}
* @param rhs the right-hand side {@code short}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final short lhs,
final short rhs) {
@@ -561,7 +561,7 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
* @param fieldName the field name
* @param lhs the left-hand side {@code short[]}
* @param rhs the right-hand side {@code short[]}
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if field name is {@code null}
*/
public DiffBuilder<T> append(final String fieldName, final short[] lhs,
final short[] rhs) {
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 bae95f9d4..a4adb1485 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -384,7 +384,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code boolean}
* @param rhs the right-hand side {@code boolean}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final boolean lhs, final boolean rhs) {
if (!isEquals) {
@@ -402,7 +402,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code boolean[]}
* @param rhs the right-hand side {@code boolean[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final boolean[] lhs, final boolean[] rhs) {
if (!isEquals) {
@@ -430,7 +430,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code byte}
* @param rhs the right-hand side {@code byte}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final byte lhs, final byte rhs) {
if (isEquals) {
@@ -447,7 +447,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code byte[]}
* @param rhs the right-hand side {@code byte[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final byte[] lhs, final byte[] rhs) {
if (!isEquals) {
@@ -475,7 +475,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code char}
* @param rhs the right-hand side {@code char}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final char lhs, final char rhs) {
if (isEquals) {
@@ -492,7 +492,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code char[]}
* @param rhs the right-hand side {@code char[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final char[] lhs, final char[] rhs) {
if (!isEquals) {
@@ -526,7 +526,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code double}
* @param rhs the right-hand side {@code double}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final double lhs, final double rhs) {
if (isEquals) {
@@ -543,7 +543,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code double[]}
* @param rhs the right-hand side {@code double[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final double[] lhs, final double[] rhs) {
if (!isEquals) {
@@ -577,7 +577,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code float}
* @param rhs the right-hand side {@code float}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final float lhs, final float rhs) {
if (isEquals) {
@@ -594,7 +594,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code float[]}
* @param rhs the right-hand side {@code float[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final float[] lhs, final float[] rhs) {
if (!isEquals) {
@@ -622,7 +622,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code int}
* @param rhs the right-hand side {@code int}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final int lhs, final int rhs) {
if (isEquals) {
@@ -639,7 +639,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code int[]}
* @param rhs the right-hand side {@code int[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final int[] lhs, final int[] rhs) {
if (!isEquals) {
@@ -669,7 +669,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* the left-hand side {@code long}
* @param rhs
* the right-hand side {@code long}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final long lhs, final long rhs) {
if (isEquals) {
@@ -686,7 +686,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code long[]}
* @param rhs the right-hand side {@code long[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final long[] lhs, final long[] rhs) {
if (!isEquals) {
@@ -718,7 +718,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side object
* @param rhs the right-hand side object
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final Object lhs, final Object rhs) {
if (!isEquals) {
@@ -756,7 +756,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code Object[]}
* @param rhs the right-hand side {@code Object[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final Object[] lhs, final Object[] rhs) {
if (!isEquals) {
@@ -784,7 +784,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code short}
* @param rhs the right-hand side {@code short}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final short lhs, final short rhs) {
if (isEquals) {
@@ -801,7 +801,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side {@code short[]}
* @param rhs the right-hand side {@code short[]}
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder append(final short[] lhs, final short[] rhs) {
if (!isEquals) {
@@ -862,7 +862,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* Adds the result of {@code super.equals()} to this builder.
*
* @param superEquals the result of calling {@code super.equals()}
- * @return this
+ * @return {@code this} instance.
* @since 2.0
*/
public EqualsBuilder appendSuper(final boolean superEquals) {
@@ -922,7 +922,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* @param lhs the left-hand side object
* @param rhs the right-hand side object
- * @return this
+ * @return {@code this} instance.
*/
public EqualsBuilder reflectionAppend(final Object lhs, final Object rhs) {
if (!isEquals) {
@@ -1041,7 +1041,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* your own set of classes here, remember to include {@link String} class,
too.</p>
*
* @param bypassReflectionClasses classes to bypass reflection test
- * @return this
+ * @return {@code this} instance.
* @see #setTestRecursive(boolean)
* @since 3.8
*/
@@ -1064,7 +1064,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* Sets field names to be excluded by reflection tests.
*
* @param excludeFields the fields to exclude
- * @return this
+ * @return {@code this} instance.
* @since 3.6
*/
public EqualsBuilder setExcludeFields(final String... excludeFields) {
@@ -1076,7 +1076,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* Sets the superclass to reflect up to at reflective tests.
*
* @param reflectUpToClass the super class to reflect up to
- * @return this
+ * @return {@code this} instance.
* @since 3.6
*/
public EqualsBuilder setReflectUpToClass(final Class<?> reflectUpToClass) {
@@ -1090,7 +1090,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* You may specify other exceptions by calling {@link
#setBypassReflectionClasses(List)}.
*
* @param testRecursive whether to do a recursive test
- * @return this
+ * @return {@code this} instance.
* @see #setBypassReflectionClasses(List)
* @since 3.6
*/
@@ -1103,7 +1103,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* Sets whether to include transient fields when reflectively comparing
objects.
*
* @param testTransients whether to test transient fields
- * @return this
+ * @return {@code this} instance.
* @since 3.6
*/
public EqualsBuilder setTestTransients(final boolean testTransients) {
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 ad258a061..c347ed654 100644
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
@@ -547,7 +547,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param value
* the boolean to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final boolean value) {
iTotal = iTotal * iConstant + (value ? 0 : 1);
@@ -559,7 +559,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final boolean[] array) {
if (array == null) {
@@ -577,7 +577,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param value
* the byte to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final byte value) {
iTotal = iTotal * iConstant + value;
@@ -589,7 +589,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final byte[] array) {
if (array == null) {
@@ -607,7 +607,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param value
* the char to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final char value) {
iTotal = iTotal * iConstant + value;
@@ -619,7 +619,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final char[] array) {
if (array == null) {
@@ -637,7 +637,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param value
* the double to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final double value) {
return append(Double.doubleToLongBits(value));
@@ -648,7 +648,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final double[] array) {
if (array == null) {
@@ -666,7 +666,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param value
* the float to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final float value) {
iTotal = iTotal * iConstant + Float.floatToIntBits(value);
@@ -678,7 +678,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final float[] array) {
if (array == null) {
@@ -696,7 +696,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param value
* the int to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final int value) {
iTotal = iTotal * iConstant + value;
@@ -708,7 +708,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final int[] array) {
if (array == null) {
@@ -726,7 +726,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param value
* the long to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
// NOTE: This method uses >> and not >>> as Effective Java and
// Long.hashCode do. Ideally we should switch to >>> at
@@ -742,7 +742,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final long[] array) {
if (array == null) {
@@ -760,7 +760,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param object
* the Object to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final Object object) {
if (object == null) {
@@ -781,7 +781,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final Object[] array) {
if (array == null) {
@@ -799,7 +799,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param value
* the short to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final short value) {
iTotal = iTotal * iConstant + value;
@@ -811,7 +811,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param array
* the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public HashCodeBuilder append(final short[] array) {
if (array == null) {
@@ -860,7 +860,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* @param superHashCode
* the result of calling {@code super.hashCode()}
- * @return this
+ * @return {@code this} instance.
* @since 2.0
*/
public HashCodeBuilder appendSuper(final int superHashCode) {
diff --git
a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
index 05f08d597..222cd249b 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
@@ -99,7 +99,7 @@ public class ReflectionDiffBuilder<T> implements
Builder<DiffResult<T>> {
* Sets the DiffBuilder.
*
* @param diffBuilder the DiffBuilder.
- * @return this.
+ * @return {@code this} instance.
*/
public Builder<T> setDiffBuilder(final DiffBuilder<T> diffBuilder) {
this.diffBuilder = diffBuilder;
@@ -110,7 +110,7 @@ public class ReflectionDiffBuilder<T> implements
Builder<DiffResult<T>> {
* Sets field names to exclude from output. Intended for fields like
{@code "password"} or {@code "lastModificationDate"}.
*
* @param excludeFieldNames field names to exclude.
- * @return this.
+ * @return {@code this} instance.
*/
public Builder<T> setExcludeFieldNames(final String...
excludeFieldNames) {
this.excludeFieldNames = toExcludeFieldNames(excludeFieldNames);
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 7950a208e..e6c83b8e0 100644
---
a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
+++
b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
@@ -746,7 +746,7 @@ public class ReflectionToStringBuilder extends
ToStringBuilder {
*
* @param array
* the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ReflectionToStringBuilder reflectionAppendArray(final Object array)
{
this.getStyle().reflectionAppendArrayDetail(this.getStringBuffer(),
null, array);
diff --git
a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
index f08eaa45e..3fa79db66 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
@@ -261,7 +261,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final boolean value) {
style.append(buffer, null, value);
@@ -273,7 +273,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final boolean[] array) {
style.append(buffer, null, array, null);
@@ -285,7 +285,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final byte value) {
style.append(buffer, null, value);
@@ -297,7 +297,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final byte[] array) {
style.append(buffer, null, array, null);
@@ -309,7 +309,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final char value) {
style.append(buffer, null, value);
@@ -321,7 +321,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final char[] array) {
style.append(buffer, null, array, null);
@@ -333,7 +333,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final double value) {
style.append(buffer, null, value);
@@ -345,7 +345,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final double[] array) {
style.append(buffer, null, array, null);
@@ -357,7 +357,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final float value) {
style.append(buffer, null, value);
@@ -369,7 +369,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final float[] array) {
style.append(buffer, null, array, null);
@@ -381,7 +381,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final int value) {
style.append(buffer, null, value);
@@ -393,7 +393,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final int[] array) {
style.append(buffer, null, array, null);
@@ -405,7 +405,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final long value) {
style.append(buffer, null, value);
@@ -417,7 +417,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final long[] array) {
style.append(buffer, null, array, null);
@@ -429,7 +429,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param obj the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final Object obj) {
style.append(buffer, null, obj, null);
@@ -441,7 +441,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final Object[] array) {
style.append(buffer, null, array, null);
@@ -453,7 +453,7 @@ public class ToStringBuilder implements Builder<String> {
* value.
*
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final short value) {
style.append(buffer, null, value);
@@ -465,7 +465,7 @@ public class ToStringBuilder implements Builder<String> {
* array.
*
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final short[] array) {
style.append(buffer, null, array, null);
@@ -478,7 +478,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final boolean value)
{
style.append(buffer, fieldName, value);
@@ -491,7 +491,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code hashCode}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final boolean[]
array) {
style.append(buffer, fieldName, array, null);
@@ -511,7 +511,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final boolean[]
array, final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -524,7 +524,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final byte value) {
style.append(buffer, fieldName, value);
@@ -536,7 +536,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final byte[] array) {
style.append(buffer, fieldName, array, null);
@@ -556,7 +556,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final byte[] array,
final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -569,7 +569,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final char value) {
style.append(buffer, fieldName, value);
@@ -582,7 +582,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final char[] array) {
style.append(buffer, fieldName, array, null);
@@ -602,7 +602,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final char[] array,
final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -615,7 +615,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final double value) {
style.append(buffer, fieldName, value);
@@ -628,7 +628,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final double[]
array) {
style.append(buffer, fieldName, array, null);
@@ -648,7 +648,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final double[]
array, final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -661,7 +661,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final float value) {
style.append(buffer, fieldName, value);
@@ -674,7 +674,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final float[] array)
{
style.append(buffer, fieldName, array, null);
@@ -694,7 +694,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final float[] array,
final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -707,7 +707,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final int value) {
style.append(buffer, fieldName, value);
@@ -720,7 +720,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final int[] array) {
style.append(buffer, fieldName, array, null);
@@ -740,7 +740,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final int[] array,
final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -753,7 +753,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final long value) {
style.append(buffer, fieldName, value);
@@ -766,7 +766,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final long[] array) {
style.append(buffer, fieldName, array, null);
@@ -786,7 +786,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final long[] array,
final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -799,7 +799,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param obj the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final Object obj) {
style.append(buffer, fieldName, obj, null);
@@ -814,7 +814,7 @@ public class ToStringBuilder implements Builder<String> {
* @param obj the value to add to the {@code toString}
* @param fullDetail {@code true} for detail,
* {@code false} for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final Object obj,
final boolean fullDetail) {
style.append(buffer, fieldName, obj, Boolean.valueOf(fullDetail));
@@ -827,7 +827,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final Object[]
array) {
style.append(buffer, fieldName, array, null);
@@ -847,7 +847,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final Object[]
array, final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -860,7 +860,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param value the value to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final short value) {
style.append(buffer, fieldName, value);
@@ -873,7 +873,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final short[] array)
{
style.append(buffer, fieldName, array, null);
@@ -893,7 +893,7 @@ public class ToStringBuilder implements Builder<String> {
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
* for summary info
- * @return this
+ * @return {@code this} instance.
*/
public ToStringBuilder append(final String fieldName, final short[] array,
final boolean fullDetail) {
style.append(buffer, fieldName, array, Boolean.valueOf(fullDetail));
@@ -906,7 +906,7 @@ public class ToStringBuilder implements Builder<String> {
* {@link System#identityHashCode(Object)}.
*
* @param srcObject the {@link Object} whose class name and id to output
- * @return this
+ * @return {@code this} instance.
* @throws NullPointerException if {@code srcObject} is {@code null}
* @since 2.0
*/
@@ -924,7 +924,7 @@ public class ToStringBuilder implements Builder<String> {
* <p>If {@code superToString} is {@code null}, no change is made.</p>
*
* @param superToString the result of {@code super.toString()}
- * @return this
+ * @return {@code this} instance.
* @since 2.0
*/
public ToStringBuilder appendSuper(final String superToString) {
@@ -958,7 +958,7 @@ public class ToStringBuilder implements Builder<String> {
* <p>If the {@code toString} is {@code null}, no change is made.</p>
*
* @param toString the result of {@code toString()} on another object
- * @return this
+ * @return {@code this} instance.
* @since 2.0
*/
public ToStringBuilder appendToString(final String toString) {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
index 003ea0ad7..3ca7f5345 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
@@ -76,7 +76,7 @@ public abstract class AbstractConcurrentInitializer<T, E
extends Exception> impl
* Sets the closer consumer called by {@link #close()}.
*
* @param closer the consumer called by {@link #close()}.
- * @return this
+ * @return {@code this} instance.
*/
public B setCloser(final FailableConsumer<T, ? extends Exception>
closer) {
this.closer = closer != null ? closer : FailableConsumer.nop();
@@ -87,7 +87,7 @@ public abstract class AbstractConcurrentInitializer<T, E
extends Exception> impl
* Sets the initializer supplier called by {@link #initialize()}.
*
* @param initializer the supplier called by {@link #initialize()}.
- * @return this
+ * @return {@code this} instance.
*/
public B setInitializer(final FailableSupplier<T, ? extends Exception>
initializer) {
this.initializer = initializer != null ? initializer :
FailableSupplier.nul();
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
index 32a02b01d..4c7a828ed 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
@@ -113,7 +113,7 @@ public class BackgroundInitializer<T> extends
AbstractConcurrentInitializer<T, E
* @see
org.apache.commons.lang3.concurrent.BackgroundInitializer#setExternalExecutor(ExecutorService)
*
* @param externalExecutor the {@link ExecutorService} to be used.
- * @return this
+ * @return {@code this} instance.
*/
public Builder<I, T> setExternalExecutor(final ExecutorService
externalExecutor) {
this.externalExecutor = externalExecutor;
diff --git a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
index 3538152ca..3dd43bef5 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
@@ -1153,7 +1153,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* endings even when on Windows.
* </p>
*
- * @return this
+ * @return {@code this} instance.
* @see #getNewLineText()
* @see #setNewLineText(String)
*/
@@ -2820,7 +2820,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Sets the text to be appended when {@link #appendNewLine() new line} is
called.
*
* @param newLine the new line text, {@code null} means use the system
default from {@link System#lineSeparator()}.
- * @return this.
+ * @return {@code this} instance.
*/
public StrBuilder setNewLineText(final String newLine) {
this.newLine = newLine;
diff --git a/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
b/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
index 49b1590e5..07bf321c1 100644
--- a/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
+++ b/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
@@ -70,7 +70,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* corresponding bit in the bit set argument also had the value {@code
true}.
*
* @param set a bit set.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet and(final BitSet set) {
bitSet.and(set);
@@ -83,7 +83,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* corresponding bit in the bit set argument also had the value {@code
true}.
*
* @param set a bit set.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet and(final FluentBitSet set) {
bitSet.and(set.bitSet);
@@ -94,7 +94,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* Clears all of the bits in this {@link BitSet} whose corresponding bit
is set in the specified {@link BitSet}.
*
* @param set the {@link BitSet} with which to mask this {@link BitSet}.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet andNot(final BitSet set) {
bitSet.andNot(set);
@@ -105,7 +105,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* Clears all of the bits in this {@link BitSet} whose corresponding bit
is set in the specified {@link BitSet}.
*
* @param set the {@link BitSet} with which to mask this {@link BitSet}.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet andNot(final FluentBitSet set) {
this.bitSet.andNot(set.bitSet);
@@ -133,7 +133,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
/**
* Sets all of the bits in this BitSet to {@code false}.
*
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet clear() {
bitSet.clear();
@@ -145,7 +145,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
*
* @param bitIndexArray the index of the bit to be cleared.
* @throws IndexOutOfBoundsException if the specified index is negative.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet clear(final int... bitIndexArray) {
for (final int e : bitIndexArray) {
@@ -159,7 +159,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
*
* @param bitIndex the index of the bit to be cleared.
* @throws IndexOutOfBoundsException if the specified index is negative.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet clear(final int bitIndex) {
bitSet.clear(bitIndex);
@@ -174,7 +174,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* @param toIndex index after the last bit to be cleared.
* @throws IndexOutOfBoundsException if {@code fromIndex} is negative, or
{@code toIndex} is negative, or
* {@code fromIndex} is larger than {@code toIndex}.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet clear(final int fromIndex, final int toIndex) {
bitSet.clear(fromIndex, toIndex);
@@ -210,7 +210,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
*
* @param bitIndex the index of the bit to flip.
* @throws IndexOutOfBoundsException if the specified index is negative.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet flip(final int bitIndex) {
bitSet.flip(bitIndex);
@@ -225,7 +225,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* @param toIndex index after the last bit to flip.
* @throws IndexOutOfBoundsException if {@code fromIndex} is negative, or
{@code toIndex} is negative, or
* {@code fromIndex} is larger than {@code toIndex}.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet flip(final int fromIndex, final int toIndex) {
bitSet.flip(fromIndex, toIndex);
@@ -346,7 +346,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* the bit set argument has the value {@code true}.
*
* @param set a bit set.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet or(final BitSet set) {
bitSet.or(set);
@@ -359,7 +359,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* the bit set argument has the value {@code true}.
*
* @param set a bit set.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet or(final FluentBitSet... set) {
for (final FluentBitSet e : set) {
@@ -374,7 +374,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* the bit set argument has the value {@code true}.
*
* @param set a bit set.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet or(final FluentBitSet set) {
this.bitSet.or(set.bitSet);
@@ -420,7 +420,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
*
* @param bitIndexArray a bit index array.
* @throws IndexOutOfBoundsException if the specified index is negative.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet set(final int... bitIndexArray) {
for (final int e : bitIndexArray) {
@@ -434,7 +434,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
*
* @param bitIndex a bit index
* @throws IndexOutOfBoundsException if the specified index is negative
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet set(final int bitIndex) {
bitSet.set(bitIndex);
@@ -447,7 +447,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* @param bitIndex a bit index.
* @param value a boolean value to set.
* @throws IndexOutOfBoundsException if the specified index is negative.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet set(final int bitIndex, final boolean value) {
bitSet.set(bitIndex, value);
@@ -462,7 +462,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* @param toIndex index after the last bit to be set.
* @throws IndexOutOfBoundsException if {@code fromIndex} is negative, or
{@code toIndex} is negative, or
* {@code fromIndex} is larger than {@code toIndex}.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet set(final int fromIndex, final int toIndex) {
bitSet.set(fromIndex, toIndex);
@@ -478,7 +478,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* @param value value to set the selected bits to.
* @throws IndexOutOfBoundsException if {@code fromIndex} is negative, or
{@code toIndex} is negative, or
* {@code fromIndex} is larger than {@code toIndex}.
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet set(final int fromIndex, final int toIndex, final
boolean value) {
bitSet.set(fromIndex, toIndex, value);
@@ -493,7 +493,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* @param toIndex index of the last bit to be set
* @throws IndexOutOfBoundsException if {@code fromIndex} is negative, or
{@code toIndex} is negative, or
* {@code fromIndex} is larger than {@code toIndex}
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet setInclusive(final int fromIndex, final int toIndex) {
bitSet.set(fromIndex, toIndex + 1);
@@ -581,7 +581,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* </ul>
*
* @param set a bit set
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet xor(final BitSet set) {
bitSet.xor(set);
@@ -599,7 +599,7 @@ public final class FluentBitSet implements Cloneable,
Serializable {
* </ul>
*
* @param set a bit set
- * @return this.
+ * @return {@code this} instance.
*/
public FluentBitSet xor(final FluentBitSet set) {
bitSet.xor(set.bitSet);
