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 7d1553622 Javadoc
7d1553622 is described below
commit 7d15536229e0f565ead115538b30ebeeeefdac4e
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 16:00:13 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/lang3/AutoCloseables.java | 2 +-
src/main/java/org/apache/commons/lang3/ObjectUtils.java | 2 +-
src/main/java/org/apache/commons/lang3/SerializationUtils.java | 2 +-
.../org/apache/commons/lang3/concurrent/BackgroundInitializer.java | 2 +-
.../commons/lang3/concurrent/CallableBackgroundInitializer.java | 2 +-
.../apache/commons/lang3/concurrent/MultiBackgroundInitializer.java | 2 +-
.../java/org/apache/commons/lang3/event/EventListenerSupport.java | 4 ++--
src/main/java/org/apache/commons/lang3/text/StrBuilder.java | 2 +-
.../apache/commons/lang3/text/translate/CharSequenceTranslator.java | 4 ++--
.../apache/commons/lang3/text/translate/CodePointTranslator.java | 2 +-
src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java | 6 +++---
src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java | 2 +-
.../org/apache/commons/lang3/time/FastDateParserReadObjectTest.java | 2 +-
13 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/AutoCloseables.java
b/src/main/java/org/apache/commons/lang3/AutoCloseables.java
index 8e87c6429..a62495fba 100644
--- a/src/main/java/org/apache/commons/lang3/AutoCloseables.java
+++ b/src/main/java/org/apache/commons/lang3/AutoCloseables.java
@@ -38,7 +38,7 @@ public class AutoCloseables {
* Closes the given {@link AutoCloseable} as a null-safe operation.
*
* @param closeable The resource to close, may be null.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
public static void close(final AutoCloseable closeable) throws Exception {
if (closeable != null) {
diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java
b/src/main/java/org/apache/commons/lang3/ObjectUtils.java
index f3f78b0ba..9f50f9fce 100644
--- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java
@@ -787,7 +787,7 @@ public static String identityHashCodeHex(final Object
object) {
*
* @param appendable The appendable to append to.
* @param object The object to create a toString for.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @since 3.2
*/
public static void identityToString(final Appendable appendable, final
Object object) throws IOException {
diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
index b9105589e..b51f10deb 100644
--- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
@@ -74,7 +74,7 @@ static final class ClassLoaderAwareObjectInputStream extends
ObjectInputStream {
*
* @param in The {@link InputStream}.
* @param classLoader classloader to use
- * @throws IOException if an I/O error occurs while reading stream
header.
+ * @throws IOException Thrown if an I/O error occurs while reading
stream header.
* @see java.io.ObjectInputStream
*/
ClassLoaderAwareObjectInputStream(final InputStream in, final
ClassLoader classLoader) throws IOException {
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 071c61667..01610704f 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
@@ -147,7 +147,7 @@ private final class InitializationTask implements
Callable<T> {
* Initiates initialization and returns the result.
*
* @return The result object
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
@Override
public T call() throws Exception {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
index 2ab243ce3..06b3c8068 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
@@ -118,7 +118,7 @@ protected Exception getTypedException(final Exception e) {
* Performs initialization in a background thread. This implementation
delegates to the {@link Callable} passed at construction time of this object.
*
* @return The result of the initialization.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
protected T initialize() throws Exception {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
index f276e1998..7a72fe207 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
@@ -315,7 +315,7 @@ protected int getTaskCount() {
* the results object. Unchecked exceptions are propagated.
*
* @return The results object.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
protected MultiBackgroundInitializerResults initialize() throws Exception {
diff --git
a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
index faa182947..ac3d2773f 100644
--- a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
+++ b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
@@ -315,7 +315,7 @@ private void initializeTransientFields(final Class<L>
listenerInterface, final C
* Deserializes the next object into this instance.
*
* @param objectInputStream The input stream.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
* @throws ClassNotFoundException if the class cannot be resolved.
*/
private void readObject(final ObjectInputStream objectInputStream) throws
IOException, ClassNotFoundException {
@@ -342,7 +342,7 @@ public void removeListener(final L listener) {
* Serializes this instance onto the given ObjectOutputStream.
*
* @param objectOutputStream The output stream
- * @throws IOException if an IO error occurs
+ * @throws IOException Thrown if an IO error occurs
*/
private void writeObject(final ObjectOutputStream objectOutputStream)
throws IOException {
final ArrayList<L> serializableListeners = new ArrayList<>();
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 d177ebed9..c91c1e239 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
@@ -2504,7 +2504,7 @@ public StrBuilder minimizeCapacity() {
*
* @param readable object to read from.
* @return The number of characters read.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @since 3.4
* @see #appendTo(Appendable)
*/
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java
b/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java
index 3ebd11d9d..07d5300f4 100644
---
a/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java
+++
b/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java
@@ -88,7 +88,7 @@ public final String translate(final CharSequence input) {
* @param index int representing the current point of translation.
* @param out Writer to translate the text to.
* @return int count of code points consumed.
- * @throws IOException if and only if the Writer produces an IOException.
+ * @throws IOException Thrown if and only if the Writer produces an
IOException.
*/
public abstract int translate(CharSequence input, int index, Writer out)
throws IOException;
@@ -98,7 +98,7 @@ public final String translate(final CharSequence input) {
*
* @param input CharSequence that is being translated.
* @param writer Writer to translate the text to.
- * @throws IOException if and only if the Writer produces an IOException.
+ * @throws IOException Thrown if and only if the Writer produces an
IOException.
*/
@SuppressWarnings("resource") // Caller closes writer
public final void translate(final CharSequence input, final Writer writer)
throws IOException {
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java
b/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java
index 4aea85fdc..d1cf77d9b 100644
---
a/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java
+++
b/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java
@@ -55,7 +55,7 @@ public final int translate(final CharSequence input, final
int index, final Writ
* @param codePoint int character input to translate.
* @param out Writer to optionally push the translated output to.
* @return boolean as to whether translation occurred or not.
- * @throws IOException if and only if the Writer produces an IOException.
+ * @throws IOException Thrown if and only if the Writer produces an
IOException.
*/
public abstract boolean translate(int codePoint, Writer out) throws
IOException;
diff --git a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
index 3b6f7b6fd..2163ab26d 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
@@ -250,7 +250,7 @@ private interface NumberRule extends Rule {
*
* @param buffer The output buffer.
* @param value The value to be appended.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
void appendTo(Appendable buffer, int value) throws IOException;
}
@@ -314,7 +314,7 @@ private interface Rule {
*
* @param buf The output buffer.
* @param calendar calendar to be appended.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
void appendTo(Appendable buf, Calendar calendar) throws IOException;
@@ -1542,7 +1542,7 @@ protected String parseToken(final String pattern, final
int[] indexRef) {
* transient properties.
*
* @param in ObjectInputStream from which the object is being deserialized.
- * @throws IOException if there is an IO issue.
+ * @throws IOException Thrown if there is an IO issue.
* @throws ClassNotFoundException if a class cannot be found.
*/
private void readObject(final ObjectInputStream in) throws IOException,
ClassNotFoundException {
diff --git a/src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java
b/src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java
index 3e4ba0a83..64a4d1c1e 100644
--- a/src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java
+++ b/src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java
@@ -341,7 +341,7 @@ void testLang313() {
/**
* Tests https://issues.apache.org/jira/browse/LANG-708
*
- * @throws IOException if an I/O error occurs
+ * @throws IOException Thrown if an I/O error occurs
*/
@Test
void testLang708() throws IOException {
diff --git
a/src/test/java/org/apache/commons/lang3/time/FastDateParserReadObjectTest.java
b/src/test/java/org/apache/commons/lang3/time/FastDateParserReadObjectTest.java
index 4b05b8978..bdf39d3c0 100644
---
a/src/test/java/org/apache/commons/lang3/time/FastDateParserReadObjectTest.java
+++
b/src/test/java/org/apache/commons/lang3/time/FastDateParserReadObjectTest.java
@@ -98,7 +98,7 @@ private static Object deserialize(final byte[] bytes) throws
IOException, ClassN
*
* @param forge The forge instance to serialize
* @return A byte array whose class descriptor names {@link FastDateParser}
- * @throws IOException if an I/O error occurs
+ * @throws IOException Thrown if an I/O error occurs
*/
private static byte[] forgeStream(final FastDateParserForge forge) throws
IOException {
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
