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 6dfd8f929..38c69e613 100644 --- a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java @@ -341,7 +341,7 @@ public class CompareToBuilder implements Builder { * result of the superclass. * * @param superCompareTo result of calling {@code super.compareTo(Object)} - * @return this - used to chain append calls + * @return this * @since 2.0 */ public CompareToBuilder appendSuper(final int superCompareTo) { @@ -367,7 +367,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand object * @param rhs right-hand object - * @return this - used to chain append calls + * @return this * @throws ClassCastException if {@code rhs} is not assignment-compatible * with {@code lhs} */ @@ -395,7 +395,7 @@ public class CompareToBuilder implements Builder { * @param rhs right-hand object * @param comparator {@link Comparator} used to compare the objects, * {@code null} means treat lhs as {@link Comparable} - * @return this - used to chain append calls + * @return this * @throws ClassCastException if {@code rhs} is not assignment-compatible * with {@code lhs} * @since 2.0 @@ -464,7 +464,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand value * @param rhs right-hand value - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final long lhs, final long rhs) { if (comparison != 0) { @@ -480,7 +480,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand value * @param rhs right-hand value - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final int lhs, final int rhs) { if (comparison != 0) { @@ -496,7 +496,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand value * @param rhs right-hand value - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final short lhs, final short rhs) { if (comparison != 0) { @@ -512,7 +512,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand value * @param rhs right-hand value - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final char lhs, final char rhs) { if (comparison != 0) { @@ -528,7 +528,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand value * @param rhs right-hand value - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final byte lhs, final byte rhs) { if (comparison != 0) { @@ -549,7 +549,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand value * @param rhs right-hand value - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final double lhs, final double rhs) { if (comparison != 0) { @@ -570,7 +570,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand value * @param rhs right-hand value - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final float lhs, final float rhs) { if (comparison != 0) { @@ -586,7 +586,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand value * @param rhs right-hand value - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final boolean lhs, final boolean rhs) { if (comparison != 0) { @@ -619,7 +619,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this * @throws ClassCastException if {@code rhs} is not assignment-compatible * with {@code lhs} */ @@ -645,7 +645,7 @@ public class CompareToBuilder implements Builder { * @param rhs right-hand 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 - used to chain append calls + * @return this * @throws ClassCastException if {@code rhs} is not assignment-compatible * with {@code lhs} * @since 2.0 @@ -688,7 +688,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final long[] lhs, final long[] rhs) { if (comparison != 0) { @@ -728,7 +728,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final int[] lhs, final int[] rhs) { if (comparison != 0) { @@ -768,7 +768,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final short[] lhs, final short[] rhs) { if (comparison != 0) { @@ -808,7 +808,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final char[] lhs, final char[] rhs) { if (comparison != 0) { @@ -848,7 +848,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final byte[] lhs, final byte[] rhs) { if (comparison != 0) { @@ -888,7 +888,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final double[] lhs, final double[] rhs) { if (comparison != 0) { @@ -928,7 +928,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final float[] lhs, final float[] rhs) { if (comparison != 0) { @@ -968,7 +968,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand array * @param rhs right-hand array - * @return this - used to chain append calls + * @return this */ public CompareToBuilder append(final boolean[] lhs, final boolean[] rhs) { if (comparison != 0) { 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 8e26a0925..6f843ca9e 100644 --- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java @@ -221,7 +221,7 @@ public class EqualsBuilder implements Builder { /** * Set whether to include transient fields when reflectively comparing objects. * @param testTransients whether to test transient fields - * @return EqualsBuilder - used to chain calls. + * @return this * @since 3.6 */ public EqualsBuilder setTestTransients(final boolean testTransients) { @@ -234,7 +234,7 @@ public class EqualsBuilder implements Builder { * String objects, which cache a hash value, are automatically excluded from recursive testing. * You may specify other exceptions by calling {@link #setBypassReflectionClasses(List)}. * @param testRecursive whether to do a recursive test - * @return EqualsBuilder - used to chain calls. + * @return this * @see #setBypassReflectionClasses(List) * @since 3.6 */ @@ -252,7 +252,7 @@ public class EqualsBuilder implements Builder { * of the {@link String} class, it is included in the default bypasses classes. Usually, if you use * your own set of classes here, remember to include {@link String} class, too.

* @param bypassReflectionClasses classes to bypass reflection test - * @return EqualsBuilder - used to chain calls. + * @return this * @see #setTestRecursive(boolean) * @since 3.8 */ @@ -264,7 +264,7 @@ public class EqualsBuilder implements Builder { /** * Set the superclass to reflect up to at reflective tests. * @param reflectUpToClass the super class to reflect up to - * @return EqualsBuilder - used to chain calls. + * @return this * @since 3.6 */ public EqualsBuilder setReflectUpToClass(final Class reflectUpToClass) { @@ -275,7 +275,7 @@ public class EqualsBuilder implements Builder { /** * Set field names to be excluded by reflection tests. * @param excludeFields the fields to exclude - * @return EqualsBuilder - used to chain calls. + * @return this * @since 3.6 */ public EqualsBuilder setExcludeFields(final String... excludeFields) { @@ -475,7 +475,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand object * @param rhs the right-hand object - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder reflectionAppend(final Object lhs, final Object rhs) { if (!isEquals) { @@ -585,7 +585,7 @@ public class EqualsBuilder implements Builder { * Adds the result of {@code super.equals()} to this builder. * * @param superEquals the result of calling {@code super.equals()} - * @return EqualsBuilder - used to chain calls. + * @return this * @since 2.0 */ public EqualsBuilder appendSuper(final boolean superEquals) { @@ -605,7 +605,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand object * @param rhs the right-hand object - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final Object lhs, final Object rhs) { if (!isEquals) { @@ -673,7 +673,7 @@ public class EqualsBuilder implements Builder { * the left-hand {@code long} * @param rhs * the right-hand {@code long} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final long lhs, final long rhs) { if (!isEquals) { @@ -688,7 +688,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code int} * @param rhs the right-hand {@code int} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final int lhs, final int rhs) { if (!isEquals) { @@ -703,7 +703,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code short} * @param rhs the right-hand {@code short} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final short lhs, final short rhs) { if (!isEquals) { @@ -718,7 +718,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code char} * @param rhs the right-hand {@code char} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final char lhs, final char rhs) { if (!isEquals) { @@ -733,7 +733,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code byte} * @param rhs the right-hand {@code byte} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final byte lhs, final byte rhs) { if (!isEquals) { @@ -754,7 +754,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code double} * @param rhs the right-hand {@code double} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final double lhs, final double rhs) { if (!isEquals) { @@ -774,7 +774,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code float} * @param rhs the right-hand {@code float} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final float lhs, final float rhs) { if (!isEquals) { @@ -788,7 +788,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code boolean} * @param rhs the right-hand {@code boolean} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final boolean lhs, final boolean rhs) { if (!isEquals) { @@ -809,7 +809,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code Object[]} * @param rhs the right-hand {@code Object[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final Object[] lhs, final Object[] rhs) { if (!isEquals) { @@ -840,7 +840,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code long[]} * @param rhs the right-hand {@code long[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final long[] lhs, final long[] rhs) { if (!isEquals) { @@ -871,7 +871,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code int[]} * @param rhs the right-hand {@code int[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final int[] lhs, final int[] rhs) { if (!isEquals) { @@ -902,7 +902,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code short[]} * @param rhs the right-hand {@code short[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final short[] lhs, final short[] rhs) { if (!isEquals) { @@ -933,7 +933,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code char[]} * @param rhs the right-hand {@code char[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final char[] lhs, final char[] rhs) { if (!isEquals) { @@ -964,7 +964,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code byte[]} * @param rhs the right-hand {@code byte[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final byte[] lhs, final byte[] rhs) { if (!isEquals) { @@ -995,7 +995,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code double[]} * @param rhs the right-hand {@code double[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final double[] lhs, final double[] rhs) { if (!isEquals) { @@ -1026,7 +1026,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code float[]} * @param rhs the right-hand {@code float[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final float[] lhs, final float[] rhs) { if (!isEquals) { @@ -1057,7 +1057,7 @@ public class EqualsBuilder implements Builder { * * @param lhs the left-hand {@code boolean[]} * @param rhs the right-hand {@code boolean[]} - * @return EqualsBuilder - used to chain calls. + * @return this */ public EqualsBuilder append(final boolean[] lhs, final boolean[] rhs) { if (!isEquals) { 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 8297fa6a6..9c86c76f7 100644 --- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java @@ -874,7 +874,7 @@ public class HashCodeBuilder implements Builder { * * @param superHashCode * the result of calling {@code super.hashCode()} - * @return this HashCodeBuilder, used to chain calls. + * @return this * @since 2.0 */ public HashCodeBuilder appendSuper(final int superHashCode) { @@ -886,7 +886,6 @@ public class HashCodeBuilder implements Builder { * Returns the computed {@code hashCode}. * * @return {@code hashCode} based on the fields appended - * * @since 3.0 */ @Override