Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve Javadoc in ExceptionUtils #1136

This commit is contained in:
Gary Gregory 2023-11-21 21:05:31 -05:00
parent e3a4d6c031
commit 9f67b81dab
2 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -46,6 +46,7 @@ The <action> type attribute can be add,update,fix,remove.
</properties> </properties>
<body> <body>
<release version="3.14.1" date="202Y-MM-DD" description="New features and bug fixes (Java 8 or above)."> <release version="3.14.1" date="202Y-MM-DD" description="New features and bug fixes (Java 8 or above).">
<action type="fix" dev="ggregory" due-to="Miklós Karakó, Gary Gregory">Improve Javadoc in ExceptionUtils #1136.</action>
</release> </release>
<release version="3.14.0" date="2023-11-18" description="New features and bug fixes (Java 8 or above)."> <release version="3.14.0" date="2023-11-18" description="New features and bug fixes (Java 8 or above).">
<!-- FIX --> <!-- FIX -->

40
src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
View File

@ -288,17 +288,17 @@ public class ExceptionUtils {
} }
/** /**
* Introspects the {@link Throwable} to obtain the root cause. * Walks the {@link Throwable} to obtain its root cause.
* *
* <p>This method walks through the exception chain to the last element, * <p>This method walks through the exception chain until the last element,
* "root" of the tree, using {@link Throwable#getCause()}, and * the root cause of the chain, using {@link Throwable#getCause()}, and
* returns that exception.</p> * returns that exception.</p>
* *
* <p>From version 2.2, this method handles recursive cause structures * <p>This method handles recursive cause chains that might
* that might otherwise cause infinite loops. If the throwable parameter * otherwise cause infinite loops. The cause chain is processed until
* has a cause of itself, then null will be returned. If the throwable * the end, or until the next item in the chain is already
* parameter cause chain loops, the last element in the chain before the * processed. If we detect a loop, then return the element before the loop.</p>
* loop is returned.</p>
* *
* @param throwable the throwable to get the root cause for, may be null * @param throwable the throwable to get the root cause for, may be null
* @return the root cause of the {@link Throwable}, * @return the root cause of the {@link Throwable},
@ -477,13 +477,13 @@ public class ExceptionUtils {
* A throwable with one cause will return {@code 2} and so on. * A throwable with one cause will return {@code 2} and so on.
* A {@code null} throwable will return {@code 0}.</p> * A {@code null} throwable will return {@code 0}.</p>
* *
* <p>From version 2.2, this method handles recursive cause structures * <p>This method handles recursive cause chains
* that might otherwise cause infinite loops. The cause chain is * that might otherwise cause infinite loops. The cause chain is
* processed until the end is reached, or until the next item in the * processed until the end, or until the next item in the
* chain is already in the result set.</p> * chain is already in the result.</p>
* *
* @param throwable the throwable to inspect, may be null * @param throwable the throwable to inspect, may be null
* @return the count of throwables, zero if null input * @return the count of throwables, zero on null input
*/ */
public static int getThrowableCount(final Throwable throwable) { public static int getThrowableCount(final Throwable throwable) {
return getThrowableList(throwable).size(); return getThrowableList(throwable).size();
@ -499,10 +499,10 @@ public class ExceptionUtils {
* two elements. - the input throwable and the cause throwable. * two elements. - the input throwable and the cause throwable.
* A {@code null} throwable will return a list of size zero.</p> * A {@code null} throwable will return a list of size zero.</p>
* *
* <p>This method handles recursive cause structures that might * <p>This method handles recursive cause chains that might
* otherwise cause infinite loops. The cause chain is processed until * otherwise cause infinite loops. The cause chain is processed until
* the end is reached, or until the next item in the chain is already * the end, or until the next item in the chain is already
* in the result set.</p> * in the result list.</p>
* *
* @param throwable the throwable to inspect, may be null * @param throwable the throwable to inspect, may be null
* @return the list of throwables, never null * @return the list of throwables, never null
@ -527,10 +527,10 @@ public class ExceptionUtils {
* two elements. - the input throwable and the cause throwable. * two elements. - the input throwable and the cause throwable.
* A {@code null} throwable will return an array of size zero.</p> * A {@code null} throwable will return an array of size zero.</p>
* *
* <p>From version 2.2, this method handles recursive cause structures * <p>This method handles recursive cause chains
* that might otherwise cause infinite loops. The cause chain is * that might otherwise cause infinite loops. The cause chain is
* processed until the end is reached, or until the next item in the * processed until the end, or until the next item in the
* chain is already in the result set.</p> * chain is already in the result array.</p>
* *
* @see #getThrowableList(Throwable) * @see #getThrowableList(Throwable)
* @param throwable the throwable to inspect, may be null * @param throwable the throwable to inspect, may be null
@ -887,8 +887,8 @@ public class ExceptionUtils {
* </p> * </p>
* *
* <p> * <p>
* This method handles recursive cause structures that might otherwise cause infinite loops. The cause chain is * This method handles recursive cause chains that might otherwise cause infinite loops. The cause chain is
* processed until the end is reached, or until the next item in the chain is already in the result set. * processed until the end, or until the next item in the chain is already in the result.
* </p> * </p>
* *
* @param throwable The Throwable to traverse * @param throwable The Throwable to traverse