diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java index c318a8a6b..c7eec43cd 100644 --- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java +++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java @@ -3284,8 +3284,8 @@ public class ArrayUtils { * Multi-dimensional primitive arrays are also handled correctly by this method. *
* - * @param array1 the left-hand array to compare, may be {@code null} - * @param array2 the right-hand array to compare, may be {@code null} + * @param array1 the left-hand side array to compare, may be {@code null} + * @param array2 the right-hand side array to compare, may be {@code null} * @return {@code true} if the arrays are equal * @deprecated this method has been replaced by {@code java.util.Objects.deepEquals(Object, Object)} and will be * removed from future releases. diff --git a/src/main/java/org/apache/commons/lang3/Range.java b/src/main/java/org/apache/commons/lang3/Range.java index 66cb5ddf4..ab0c67a5f 100644 --- a/src/main/java/org/apache/commons/lang3/Range.java +++ b/src/main/java/org/apache/commons/lang3/Range.java @@ -40,8 +40,8 @@ public class RangeIf both {@code lhs} and {@code rhs} are {@code null}, * they are considered equal.
* - * @param lhs left-hand object - * @param rhs right-hand object + * @param lhs left-hand side object + * @param rhs right-hand side object * @return a negative integer, zero, or a positive integer as {@code lhs} * is less than, equal to, or greater than {@code rhs} * @throws NullPointerException if either (but not both) parameters are @@ -178,8 +178,8 @@ public class CompareToBuilder implements BuilderIf both {@code lhs} and {@code rhs} are {@code null}, * they are considered equal.
* - * @param lhs left-hand object - * @param rhs right-hand object + * @param lhs left-hand side object + * @param rhs right-hand side object * @param compareTransients whether to compare transient fields * @return a negative integer, zero, or a positive integer as {@code lhs} * is less than, equal to, or greater than {@code rhs} @@ -211,8 +211,8 @@ public class CompareToBuilder implements BuilderIf both {@code lhs} and {@code rhs} are {@code null}, * they are considered equal.
* - * @param lhs left-hand object - * @param rhs right-hand object + * @param lhs left-hand side object + * @param rhs right-hand side object * @param compareTransients whether to compare transient fields * @param reflectUpToClass last superclass for which fields are compared * @param excludeFields fields to exclude @@ -268,8 +268,8 @@ public class CompareToBuilder implements BuilderIf both {@code lhs} and {@code rhs} are {@code null}, * they are considered equal.
* - * @param lhs left-hand object - * @param rhs right-hand object + * @param lhs left-hand side object + * @param rhs right-hand side object * @param excludeFields Collection of String fields to exclude * @return a negative integer, zero, or a positive integer as {@code lhs} * is less than, equal to, or greater than {@code rhs} @@ -301,8 +301,8 @@ public class CompareToBuilder implements BuilderIf both {@code lhs} and {@code rhs} are {@code null}, * they are considered equal.
* - * @param lhs left-hand object - * @param rhs right-hand object + * @param lhs left-hand side object + * @param rhs right-hand side object * @param excludeFields array of fields to exclude * @return a negative integer, zero, or a positive integer as {@code lhs} * is less than, equal to, or greater than {@code rhs} @@ -336,8 +336,8 @@ public class CompareToBuilder implements BuilderIt is compatible with the hash code generated by * {@link HashCodeBuilder}.
* - * @param lhs left-hand value - * @param rhs right-hand value + * @param lhs left-hand side value + * @param rhs right-hand side value * @return this */ public CompareToBuilder append(final double lhs, final double rhs) { @@ -539,8 +539,8 @@ public class CompareToBuilder implements BuilderIt is compatible with the hash code generated by * {@link HashCodeBuilder}.
* - * @param lhs left-hand value - * @param rhs right-hand value + * @param lhs left-hand side value + * @param rhs right-hand side value * @return this */ public CompareToBuilder append(final float lhs, final float rhs) { @@ -600,8 +600,8 @@ public class CompareToBuilder implements Builder{@code lhs} must either be an array or implement {@link Comparable}.
* - * @param lhs left-hand object - * @param rhs right-hand object + * @param lhs left-hand side object + * @param rhs right-hand side object * @return this * @throws ClassCastException if {@code rhs} is not assignment-compatible * with {@code lhs} @@ -780,8 +780,8 @@ public class CompareToBuilder implements BuilderThis method will also will be called for the top level of multi-dimensional, * ragged, and multi-typed arrays.
* - * @param lhs left-hand array - * @param rhs right-hand array + * @param lhs left-hand side array + * @param rhs right-hand side array * @return this * @throws ClassCastException if {@code rhs} is not assignment-compatible * with {@code lhs} @@ -858,8 +858,8 @@ public class CompareToBuilder implements BuilderThis method will also will be called for the top level of multi-dimensional, * ragged, and multi-typed arrays.
* - * @param lhs left-hand array - * @param rhs right-hand array + * @param lhs left-hand side array + * @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 @@ -896,8 +896,8 @@ public class CompareToBuilder implements BuilderThe method {@link #append(boolean, boolean)} is used.
* - * @param lhs the left-hand {@code boolean[]} - * @param rhs the right-hand {@code boolean[]} + * @param lhs the left-hand side {@code boolean[]} + * @param rhs the right-hand side {@code boolean[]} * @return this */ public EqualsBuilder append(final boolean[] lhs, final boolean[] rhs) { @@ -433,8 +433,8 @@ public class EqualsBuilder implements BuilderThe method {@link #append(byte, byte)} is used.
* - * @param lhs the left-hand {@code byte[]} - * @param rhs the right-hand {@code byte[]} + * @param lhs the left-hand side {@code byte[]} + * @param rhs the right-hand side {@code byte[]} * @return this */ public EqualsBuilder append(final byte[] lhs, final byte[] rhs) { @@ -479,8 +479,8 @@ public class EqualsBuilder implements BuilderThe method {@link #append(char, char)} is used.
* - * @param lhs the left-hand {@code char[]} - * @param rhs the right-hand {@code char[]} + * @param lhs the left-hand side {@code char[]} + * @param rhs the right-hand side {@code char[]} * @return this */ public EqualsBuilder append(final char[] lhs, final char[] rhs) { @@ -531,8 +531,8 @@ public class EqualsBuilder implements BuilderIt is compatible with the hash code generated by * {@link HashCodeBuilder}.
* - * @param lhs the left-hand {@code double} - * @param rhs the right-hand {@code double} + * @param lhs the left-hand side {@code double} + * @param rhs the right-hand side {@code double} * @return this */ public EqualsBuilder append(final double lhs, final double rhs) { @@ -548,8 +548,8 @@ public class EqualsBuilder implements BuilderThe method {@link #append(double, double)} is used.
* - * @param lhs the left-hand {@code double[]} - * @param rhs the right-hand {@code double[]} + * @param lhs the left-hand side {@code double[]} + * @param rhs the right-hand side {@code double[]} * @return this */ public EqualsBuilder append(final double[] lhs, final double[] rhs) { @@ -582,8 +582,8 @@ public class EqualsBuilder implements BuilderIt is compatible with the hash code generated by * {@link HashCodeBuilder}.
* - * @param lhs the left-hand {@code float} - * @param rhs the right-hand {@code float} + * @param lhs the left-hand side {@code float} + * @param rhs the right-hand side {@code float} * @return this */ public EqualsBuilder append(final float lhs, final float rhs) { @@ -599,8 +599,8 @@ public class EqualsBuilder implements BuilderThe method {@link #append(float, float)} is used.
* - * @param lhs the left-hand {@code float[]} - * @param rhs the right-hand {@code float[]} + * @param lhs the left-hand side {@code float[]} + * @param rhs the right-hand side {@code float[]} * @return this */ public EqualsBuilder append(final float[] lhs, final float[] rhs) { @@ -627,8 +627,8 @@ public class EqualsBuilder implements BuilderThe method {@link #append(int, int)} is used.
* - * @param lhs the left-hand {@code int[]} - * @param rhs the right-hand {@code int[]} + * @param lhs the left-hand side {@code int[]} + * @param rhs the right-hand side {@code int[]} * @return this */ public EqualsBuilder append(final int[] lhs, final int[] rhs) { @@ -674,9 +674,9 @@ public class EqualsBuilder implements BuilderThe method {@link #append(long, long)} is used.
* - * @param lhs the left-hand {@code long[]} - * @param rhs the right-hand {@code long[]} + * @param lhs the left-hand side {@code long[]} + * @param rhs the right-hand side {@code long[]} * @return this */ public EqualsBuilder append(final long[] lhs, final long[] rhs) { @@ -725,8 +725,8 @@ public class EqualsBuilder implements BuilderNote that this method does not compare the type of the arrays; it only * compares the contents.
* - * @param lhs the left-hand {@code Object[]} - * @param rhs the right-hand {@code Object[]} + * @param lhs the left-hand side {@code Object[]} + * @param rhs the right-hand side {@code Object[]} * @return this */ public EqualsBuilder append(final Object[] lhs, final Object[] rhs) { @@ -791,8 +791,8 @@ public class EqualsBuilder implements BuilderThe method {@link #append(short, short)} is used.
* - * @param lhs the left-hand {@code short[]} - * @param rhs the right-hand {@code short[]} + * @param lhs the left-hand side {@code short[]} + * @param rhs the right-hand side {@code short[]} * @return this */ public EqualsBuilder append(final short[] lhs, final short[] rhs) { @@ -837,8 +837,8 @@ public class EqualsBuilder implements BuilderIf either class of the compared objects is contained in * {@code bypassReflectionClasses}, both objects are compared by calling - * the equals method of the left-hand object with the right-hand object as an argument.
+ * the equals method of the left-hand side object with the right-hand side object as an argument. * - * @param lhs the left-hand object - * @param rhs the right-hand object + * @param lhs the left-hand side object + * @param rhs the right-hand side object * @return this */ public EqualsBuilder reflectionAppend(final Object lhs, final Object rhs) { @@ -1000,8 +1000,8 @@ public class EqualsBuilder implements BuilderThis method formats durations using the days and lower fields of the * format pattern. Months and larger are not used.
* * @param durationMillis the duration to format * @param format the way in which to format the duration, not null - * @param padWithZeros whether to pad the left-hand side of numbers with 0's + * @param padWithZeros whether to pad the left-hand side side of numbers with 0's * @return the formatted duration, not null * @throws IllegalArgumentException if durationMillis is negative */ @@ -469,7 +469,7 @@ public class DurationFormatUtils { } /** * Formats the time gap as a string, using the specified format. - * Padding the left-hand side of numbers with zeroes is optional. + * Padding the left-hand side side of numbers with zeroes is optional. * * @param startMillis the start of the duration * @param endMillis the end of the duration @@ -482,7 +482,7 @@ public class DurationFormatUtils { } /** *Formats the time gap as a string, using the specified format. - * Padding the left-hand side of numbers with zeroes is optional and + * Padding the left-hand side side of numbers with zeroes is optional and * the time zone may be specified. * *
When calculating the difference between months/days, it chooses to @@ -499,7 +499,7 @@ public class DurationFormatUtils { * @param startMillis the start of the duration * @param endMillis the end of the duration * @param format the way in which to format the duration, not null - * @param padWithZeros whether to pad the left-hand side of numbers with 0's + * @param padWithZeros whether to pad the left-hand side side of numbers with 0's * @param timezone the millis are defined in * @return the formatted duration, not null * @throws IllegalArgumentException if startMillis is greater than endMillis diff --git a/src/test/java/org/apache/commons/lang3/builder/EqualsBuilderTest.java b/src/test/java/org/apache/commons/lang3/builder/EqualsBuilderTest.java index 4f2b21450..7614377de 100644 --- a/src/test/java/org/apache/commons/lang3/builder/EqualsBuilderTest.java +++ b/src/test/java/org/apache/commons/lang3/builder/EqualsBuilderTest.java @@ -1168,7 +1168,7 @@ public class EqualsBuilderTest extends AbstractLangTest { * * @param to a TestObject * @param toBis a TestObject, equal to to and toTer - * @param toTer left-hand side, equal to to and toBis + * @param toTer left-hand side side, equal to to and toBis * @param to2 a different TestObject * @param oToChange a TestObject that will be changed * @param testTransients whether to test transient instance variables