This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 4d5ac2df8 Javadoc
4d5ac2df8 is described below
commit 4d5ac2df889aa6f18389e0be0fc74b08271bc11f
Author: Gary Gregory <[email protected]>
AuthorDate: Sun May 24 07:53:24 2026 -0400
Javadoc
Remove @since tags on private or package-private elements.
---
.../commons/lang3/builder/EqualsBuilder.java | 4 +-
.../commons/lang3/builder/HashCodeBuilder.java | 55 ++++++-------
.../commons/lang3/builder/ToStringBuilder.java | 92 +++++++++++-----------
3 files changed, 69 insertions(+), 82 deletions(-)
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 c478ff335..6ecc6b8a7 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -111,9 +111,7 @@ public EqualsBuilder get() {
}
/**
- * A registry of objects used by reflection methods to detect cyclical
object references and avoid infinite loops.
- *
- * @since 3.0
+ * A registry of objects to detect cyclical object references, avoid
infinite loops, and stack overflows.
*/
private static final ThreadLocal<Set<Pair<IDKey, IDKey>>> REGISTRY =
ThreadLocal.withInitial(HashSet::new);
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 b45990f53..ae8aa2966 100644
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
@@ -165,9 +165,7 @@ public Builder setMultiplierOddNumber(final int
multiplierOddNumber) {
private static final int DEFAULT_MULTIPLIER_VALUE = 37;
/**
- * A registry of objects used by reflection methods to detect cyclical
object references and avoid infinite loops.
- *
- * @since 2.3
+ * A registry of objects to detect cyclical object references, avoid
infinite loops, and stack overflows.
*/
private static final ThreadLocal<Set<IDKey>> REGISTRY =
ThreadLocal.withInitial(HashSet::new);
@@ -201,7 +199,6 @@ public static Builder builder() {
* Gets the registry of objects being traversed by the reflection methods
in the current thread.
*
* @return Set the registry of objects being traversed
- * @since 2.3
*/
static Set<IDKey> getRegistry() {
return REGISTRY.get();
@@ -214,7 +211,6 @@ static Set<IDKey> getRegistry() {
* @param value
* The object to lookup in the registry.
* @return boolean {@code true} if the registry contains the given object.
- * @since 2.3
*/
static boolean isRegistered(final Object value) {
final Set<IDKey> registry = getRegistry();
@@ -296,7 +292,6 @@ private static void reflectionAppend(final Object object,
final Class<?> clazz,
* if the Object is {@code null}
* @throws IllegalArgumentException
* if the number is zero or even
- *
* @see HashCodeExclude
*/
public static int reflectionHashCode(final int initialNonZeroOddNumber,
final int multiplierNonZeroOddNumber, final Object object) {
@@ -340,7 +335,6 @@ public static int reflectionHashCode(final int
initialNonZeroOddNumber, final in
* if the Object is {@code null}
* @throws IllegalArgumentException
* if the number is zero or even
- *
* @see HashCodeExclude
*/
public static int reflectionHashCode(final int initialNonZeroOddNumber,
final int multiplierNonZeroOddNumber, final Object object,
@@ -392,7 +386,6 @@ public static int reflectionHashCode(final int
initialNonZeroOddNumber, final in
* if the Object is {@code null}
* @throws IllegalArgumentException
* if the number is zero or even
- *
* @see HashCodeExclude
* @since 2.0
*/
@@ -439,7 +432,6 @@ public static <T> int reflectionHashCode(final int
initialNonZeroOddNumber, fina
* @return int hash code
* @throws NullPointerException
* if the object is {@code null}
- *
* @see HashCodeExclude
*/
public static int reflectionHashCode(final Object object, final boolean
testTransients) {
@@ -477,7 +469,6 @@ public static int reflectionHashCode(final Object object,
final boolean testTran
* @return int hash code
* @throws NullPointerException
* if the object is {@code null}
- *
* @see HashCodeExclude
*/
public static int reflectionHashCode(final Object object, final
Collection<String> excludeFields) {
@@ -514,7 +505,6 @@ public static int reflectionHashCode(final Object object,
final Collection<Strin
* @return int hash code
* @throws NullPointerException
* if the object is {@code null}
- *
* @see HashCodeExclude
*/
public static int reflectionHashCode(final Object object, final String...
excludeFields) {
@@ -595,7 +585,7 @@ public HashCodeBuilder(final int initialOddNumber, final
int multiplierOddNumber
}
/**
- * Append a {@code hashCode} for a {@code boolean}.
+ * Appends a {@code hashCode} for a {@code boolean}.
*
* <p>
* This adds {@code 1} when true, and {@code 0} when false to the {@code
hashCode}.
@@ -620,7 +610,7 @@ public HashCodeBuilder append(final boolean value) {
}
/**
- * Append a {@code hashCode} for a {@code boolean} array.
+ * Appends a {@code hashCode} for a {@code boolean} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -638,7 +628,7 @@ public HashCodeBuilder append(final boolean[] array) {
}
/**
- * Append a {@code hashCode} for a {@code byte}.
+ * Appends a {@code hashCode} for a {@code byte}.
*
* @param value
* the byte to add to the {@code hashCode}
@@ -650,7 +640,7 @@ public HashCodeBuilder append(final byte value) {
}
/**
- * Append a {@code hashCode} for a {@code byte} array.
+ * Appends a {@code hashCode} for a {@code byte} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -668,7 +658,7 @@ public HashCodeBuilder append(final byte[] array) {
}
/**
- * Append a {@code hashCode} for a {@code char}.
+ * Appends a {@code hashCode} for a {@code char}.
*
* @param value
* the char to add to the {@code hashCode}
@@ -680,7 +670,7 @@ public HashCodeBuilder append(final char value) {
}
/**
- * Append a {@code hashCode} for a {@code char} array.
+ * Appends a {@code hashCode} for a {@code char} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -698,7 +688,7 @@ public HashCodeBuilder append(final char[] array) {
}
/**
- * Append a {@code hashCode} for a {@code double}.
+ * Appends a {@code hashCode} for a {@code double}.
*
* @param value
* the double to add to the {@code hashCode}
@@ -709,7 +699,7 @@ public HashCodeBuilder append(final double value) {
}
/**
- * Append a {@code hashCode} for a {@code double} array.
+ * Appends a {@code hashCode} for a {@code double} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -727,7 +717,7 @@ public HashCodeBuilder append(final double[] array) {
}
/**
- * Append a {@code hashCode} for a {@code float}.
+ * Appends a {@code hashCode} for a {@code float}.
*
* @param value
* the float to add to the {@code hashCode}
@@ -739,7 +729,7 @@ public HashCodeBuilder append(final float value) {
}
/**
- * Append a {@code hashCode} for a {@code float} array.
+ * Appends a {@code hashCode} for a {@code float} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -757,7 +747,7 @@ public HashCodeBuilder append(final float[] array) {
}
/**
- * Append a {@code hashCode} for an {@code int}.
+ * Appends a {@code hashCode} for an {@code int}.
*
* @param value
* the int to add to the {@code hashCode}
@@ -769,7 +759,7 @@ public HashCodeBuilder append(final int value) {
}
/**
- * Append a {@code hashCode} for an {@code int} array.
+ * Appends a {@code hashCode} for an {@code int} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -787,7 +777,7 @@ public HashCodeBuilder append(final int[] array) {
}
/**
- * Append a {@code hashCode} for a {@code long}.
+ * Appends a {@code hashCode} for a {@code long}.
*
* @param value
* the long to add to the {@code hashCode}
@@ -803,7 +793,7 @@ public HashCodeBuilder append(final long value) {
}
/**
- * Append a {@code hashCode} for a {@code long} array.
+ * Appends a {@code hashCode} for a {@code long} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -821,7 +811,7 @@ public HashCodeBuilder append(final long[] array) {
}
/**
- * Append a {@code hashCode} for an {@link Object}.
+ * Appends a {@code hashCode} for an {@link Object}.
*
* @param object
* the Object to add to the {@code hashCode}
@@ -852,7 +842,7 @@ public HashCodeBuilder append(final Object object) {
}
/**
- * Append a {@code hashCode} for an {@link Object} array.
+ * Appends a {@code hashCode} for an {@link Object} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -870,7 +860,7 @@ public HashCodeBuilder append(final Object[] array) {
}
/**
- * Append a {@code hashCode} for a {@code short}.
+ * Appends a {@code hashCode} for a {@code short}.
*
* @param value
* the short to add to the {@code hashCode}
@@ -882,7 +872,7 @@ public HashCodeBuilder append(final short value) {
}
/**
- * Append a {@code hashCode} for a {@code short} array.
+ * Appends a {@code hashCode} for a {@code short} array.
*
* @param array
* the array to add to the {@code hashCode}
@@ -900,7 +890,7 @@ public HashCodeBuilder append(final short[] array) {
}
/**
- * Append a {@code hashCode} for an array.
+ * Appends a {@code hashCode} for an array.
*
* @param object
* the array to add to the {@code hashCode}
@@ -972,9 +962,8 @@ public boolean equals(final Object obj) {
}
/**
- * The computed {@code hashCode} from toHashCode() is returned due to the
likelihood
- * of bugs in mis-calling toHashCode() and the unlikeliness of it
mattering what the hashCode for
- * HashCodeBuilder itself is.
+ * Returns the computed {@code hashCode} from {@link #toHashCode()} due to
the likelihood of bugs in mis-calling {@link #toHashCode()} and the unlikeliness
+ * of it mattering what the hashCode for {@link HashCodeBuilder} itself is.
*
* @return {@code hashCode} based on the fields appended
* @since 2.5
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 3919c00f4..c05dc7941 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
@@ -329,7 +329,7 @@ public ToStringBuilder(final Object object, final
ToStringStyle style, final Str
}
/**
- * Append to the {@code toString} a {@code boolean}
+ * Appends to the {@code toString} a {@code boolean}
* value.
*
* @param value the value to add to the {@code toString}
@@ -341,7 +341,7 @@ public ToStringBuilder append(final boolean value) {
}
/**
- * Append to the {@code toString} a {@code boolean}
+ * Appends to the {@code toString} a {@code boolean}
* array.
*
* @param array the array to add to the {@code toString}
@@ -353,7 +353,7 @@ public ToStringBuilder append(final boolean[] array) {
}
/**
- * Append to the {@code toString} a {@code byte}
+ * Appends to the {@code toString} a {@code byte}
* value.
*
* @param value the value to add to the {@code toString}
@@ -365,7 +365,7 @@ public ToStringBuilder append(final byte value) {
}
/**
- * Append to the {@code toString} a {@code byte}
+ * Appends to the {@code toString} a {@code byte}
* array.
*
* @param array the array to add to the {@code toString}
@@ -377,7 +377,7 @@ public ToStringBuilder append(final byte[] array) {
}
/**
- * Append to the {@code toString} a {@code char}
+ * Appends to the {@code toString} a {@code char}
* value.
*
* @param value the value to add to the {@code toString}
@@ -389,7 +389,7 @@ public ToStringBuilder append(final char value) {
}
/**
- * Append to the {@code toString} a {@code char}
+ * Appends to the {@code toString} a {@code char}
* array.
*
* @param array the array to add to the {@code toString}
@@ -401,7 +401,7 @@ public ToStringBuilder append(final char[] array) {
}
/**
- * Append to the {@code toString} a {@code double}
+ * Appends to the {@code toString} a {@code double}
* value.
*
* @param value the value to add to the {@code toString}
@@ -413,7 +413,7 @@ public ToStringBuilder append(final double value) {
}
/**
- * Append to the {@code toString} a {@code double}
+ * Appends to the {@code toString} a {@code double}
* array.
*
* @param array the array to add to the {@code toString}
@@ -425,7 +425,7 @@ public ToStringBuilder append(final double[] array) {
}
/**
- * Append to the {@code toString} a {@code float}
+ * Appends to the {@code toString} a {@code float}
* value.
*
* @param value the value to add to the {@code toString}
@@ -437,7 +437,7 @@ public ToStringBuilder append(final float value) {
}
/**
- * Append to the {@code toString} a {@code float}
+ * Appends to the {@code toString} a {@code float}
* array.
*
* @param array the array to add to the {@code toString}
@@ -449,7 +449,7 @@ public ToStringBuilder append(final float[] array) {
}
/**
- * Append to the {@code toString} an {@code int}
+ * Appends to the {@code toString} an {@code int}
* value.
*
* @param value the value to add to the {@code toString}
@@ -461,7 +461,7 @@ public ToStringBuilder append(final int value) {
}
/**
- * Append to the {@code toString} an {@code int}
+ * Appends to the {@code toString} an {@code int}
* array.
*
* @param array the array to add to the {@code toString}
@@ -473,7 +473,7 @@ public ToStringBuilder append(final int[] array) {
}
/**
- * Append to the {@code toString} a {@code long}
+ * Appends to the {@code toString} a {@code long}
* value.
*
* @param value the value to add to the {@code toString}
@@ -485,7 +485,7 @@ public ToStringBuilder append(final long value) {
}
/**
- * Append to the {@code toString} a {@code long}
+ * Appends to the {@code toString} a {@code long}
* array.
*
* @param array the array to add to the {@code toString}
@@ -497,7 +497,7 @@ public ToStringBuilder append(final long[] array) {
}
/**
- * Append to the {@code toString} an {@link Object}
+ * Appends to the {@code toString} an {@link Object}
* value.
*
* @param obj the value to add to the {@code toString}
@@ -509,7 +509,7 @@ public ToStringBuilder append(final Object obj) {
}
/**
- * Append to the {@code toString} an {@link Object}
+ * Appends to the {@code toString} an {@link Object}
* array.
*
* @param array the array to add to the {@code toString}
@@ -521,7 +521,7 @@ public ToStringBuilder append(final Object[] array) {
}
/**
- * Append to the {@code toString} a {@code short}
+ * Appends to the {@code toString} a {@code short}
* value.
*
* @param value the value to add to the {@code toString}
@@ -533,7 +533,7 @@ public ToStringBuilder append(final short value) {
}
/**
- * Append to the {@code toString} a {@code short}
+ * Appends to the {@code toString} a {@code short}
* array.
*
* @param array the array to add to the {@code toString}
@@ -545,7 +545,7 @@ public ToStringBuilder append(final short[] array) {
}
/**
- * Append to the {@code toString} a {@code boolean}
+ * Appends to the {@code toString} a {@code boolean}
* value.
*
* @param fieldName the field name
@@ -558,7 +558,7 @@ public ToStringBuilder append(final String fieldName, final
boolean value) {
}
/**
- * Append to the {@code toString} a {@code boolean}
+ * Appends to the {@code toString} a {@code boolean}
* array.
*
* @param fieldName the field name
@@ -571,7 +571,7 @@ public ToStringBuilder append(final String fieldName, final
boolean[] array) {
}
/**
- * Append to the {@code toString} a {@code boolean}
+ * Appends to the {@code toString} a {@code boolean}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
@@ -591,7 +591,7 @@ public ToStringBuilder append(final String fieldName, final
boolean[] array, fin
}
/**
- * Append to the {@code toString} an {@code byte}
+ * Appends to the {@code toString} an {@code byte}
* value.
*
* @param fieldName the field name
@@ -604,7 +604,7 @@ public ToStringBuilder append(final String fieldName, final
byte value) {
}
/**
- * Append to the {@code toString} a {@code byte} array.
+ * Appends to the {@code toString} a {@code byte} array.
*
* @param fieldName the field name
* @param array the array to add to the {@code toString}
@@ -616,7 +616,7 @@ public ToStringBuilder append(final String fieldName, final
byte[] array) {
}
/**
- * Append to the {@code toString} a {@code byte}
+ * Appends to the {@code toString} a {@code byte}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
@@ -636,7 +636,7 @@ public ToStringBuilder append(final String fieldName, final
byte[] array, final
}
/**
- * Append to the {@code toString} a {@code char}
+ * Appends to the {@code toString} a {@code char}
* value.
*
* @param fieldName the field name
@@ -649,7 +649,7 @@ public ToStringBuilder append(final String fieldName, final
char value) {
}
/**
- * Append to the {@code toString} a {@code char}
+ * Appends to the {@code toString} a {@code char}
* array.
*
* @param fieldName the field name
@@ -662,7 +662,7 @@ public ToStringBuilder append(final String fieldName, final
char[] array) {
}
/**
- * Append to the {@code toString} a {@code char}
+ * Appends to the {@code toString} a {@code char}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
@@ -682,7 +682,7 @@ public ToStringBuilder append(final String fieldName, final
char[] array, final
}
/**
- * Append to the {@code toString} a {@code double}
+ * Appends to the {@code toString} a {@code double}
* value.
*
* @param fieldName the field name
@@ -695,7 +695,7 @@ public ToStringBuilder append(final String fieldName, final
double value) {
}
/**
- * Append to the {@code toString} a {@code double}
+ * Appends to the {@code toString} a {@code double}
* array.
*
* @param fieldName the field name
@@ -708,7 +708,7 @@ public ToStringBuilder append(final String fieldName, final
double[] array) {
}
/**
- * Append to the {@code toString} a {@code double}
+ * Appends to the {@code toString} a {@code double}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
@@ -728,7 +728,7 @@ public ToStringBuilder append(final String fieldName, final
double[] array, fina
}
/**
- * Append to the {@code toString} an {@code float}
+ * Appends to the {@code toString} an {@code float}
* value.
*
* @param fieldName the field name
@@ -741,7 +741,7 @@ public ToStringBuilder append(final String fieldName, final
float value) {
}
/**
- * Append to the {@code toString} a {@code float}
+ * Appends to the {@code toString} a {@code float}
* array.
*
* @param fieldName the field name
@@ -754,7 +754,7 @@ public ToStringBuilder append(final String fieldName, final
float[] array) {
}
/**
- * Append to the {@code toString} a {@code float}
+ * Appends to the {@code toString} a {@code float}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
@@ -774,7 +774,7 @@ public ToStringBuilder append(final String fieldName, final
float[] array, final
}
/**
- * Append to the {@code toString} an {@code int}
+ * Appends to the {@code toString} an {@code int}
* value.
*
* @param fieldName the field name
@@ -787,7 +787,7 @@ public ToStringBuilder append(final String fieldName, final
int value) {
}
/**
- * Append to the {@code toString} an {@code int}
+ * Appends to the {@code toString} an {@code int}
* array.
*
* @param fieldName the field name
@@ -800,7 +800,7 @@ public ToStringBuilder append(final String fieldName, final
int[] array) {
}
/**
- * Append to the {@code toString} an {@code int}
+ * Appends to the {@code toString} an {@code int}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
@@ -820,7 +820,7 @@ public ToStringBuilder append(final String fieldName, final
int[] array, final b
}
/**
- * Append to the {@code toString} a {@code long}
+ * Appends to the {@code toString} a {@code long}
* value.
*
* @param fieldName the field name
@@ -833,7 +833,7 @@ public ToStringBuilder append(final String fieldName, final
long value) {
}
/**
- * Append to the {@code toString} a {@code long}
+ * Appends to the {@code toString} a {@code long}
* array.
*
* @param fieldName the field name
@@ -846,7 +846,7 @@ public ToStringBuilder append(final String fieldName, final
long[] array) {
}
/**
- * Append to the {@code toString} a {@code long}
+ * Appends to the {@code toString} a {@code long}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
@@ -866,7 +866,7 @@ public ToStringBuilder append(final String fieldName, final
long[] array, final
}
/**
- * Append to the {@code toString} an {@link Object}
+ * Appends to the {@code toString} an {@link Object}
* value.
*
* @param fieldName the field name
@@ -879,7 +879,7 @@ public ToStringBuilder append(final String fieldName, final
Object obj) {
}
/**
- * Append to the {@code toString} an {@link Object}
+ * Appends to the {@code toString} an {@link Object}
* value.
*
* @param fieldName the field name
@@ -894,7 +894,7 @@ public ToStringBuilder append(final String fieldName, final
Object obj, final bo
}
/**
- * Append to the {@code toString} an {@link Object}
+ * Appends to the {@code toString} an {@link Object}
* array.
*
* @param fieldName the field name
@@ -907,7 +907,7 @@ public ToStringBuilder append(final String fieldName, final
Object[] array) {
}
/**
- * Append to the {@code toString} an {@link Object}
+ * Appends to the {@code toString} an {@link Object}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
@@ -927,7 +927,7 @@ public ToStringBuilder append(final String fieldName, final
Object[] array, fina
}
/**
- * Append to the {@code toString} an {@code short}
+ * Appends to the {@code toString} an {@code short}
* value.
*
* @param fieldName the field name
@@ -940,7 +940,7 @@ public ToStringBuilder append(final String fieldName, final
short value) {
}
/**
- * Append to the {@code toString} a {@code short}
+ * Appends to the {@code toString} a {@code short}
* array.
*
* @param fieldName the field name
@@ -953,7 +953,7 @@ public ToStringBuilder append(final String fieldName, final
short[] array) {
}
/**
- * Append to the {@code toString} a {@code short}
+ * Appends to the {@code toString} a {@code short}
* array.
*
* <p>A boolean parameter controls the level of detail to show.
