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 132b1043c Fix LockingVisitors Javadoc to match code (f017).
132b1043c is described below
commit 132b1043c1882e732b9215316e7cd3c717622fad
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Sep 5 14:04:24 2026 -0400
Fix LockingVisitors Javadoc to match code (f017).
---
src/changes/changes.xml | 1 +
.../apache/commons/lang3/concurrent/locks/LockingVisitors.java | 9 +++------
2 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 3059ea139..b8e760504 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -266,6 +266,7 @@ java.lang.NullPointerException: Cannot invoke
<action type="fix" dev="ggregory" due-to="Gary
Gregory">DurationFormatUtils.formatPeriod walks the calendar one year per
iteration, Long.MAX_VALUE endMillis forces ~292 million Calendar round trips on
one thread (f014).</action>
<action type="fix" dev="ggregory" due-to="Gary
Gregory">JavaVersion.get() throws NumberFormatException where javadoc promises
null (f015).</action>
<action type="fix" dev="ggregory" due-to="Gary
Gregory">Match Javadoc to code in SystemProperties.getProperty() and
SystemUtils.getEnvironmentVariable() and update inline comments (f016).</action>
+ <action type="fix" dev="ggregory" due-to="Gary
Gregory">Fix LockingVisitors Javadoc to match code (f017).</action>
<!-- ADD -->
<action type="add" dev="ggregory" due-to="Gary
Gregory">Add JavaVersion.JAVA_27.</action>
<action type="add" dev="ggregory" due-to="Gary
Gregory">Add SystemUtils.IS_JAVA_27.</action>
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
b/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
index cff71d765..a398df47c 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
@@ -362,8 +362,7 @@ public void acceptWriteLocked(final FailableConsumer<O, ?>
consumer) {
* @param function The function, which is being invoked to compute the
result. The function will receive the
* hidden object.
* @return The result object, which has been returned by the functions
invocation.
- * @throws IllegalStateException The result object would be, in fact,
the hidden object. This would extend
- * access to the hidden object beyond this methods lifetime
and will therefore be prevented.
+ * @throws NullPointerException Thrown if the lock supplier is null or
returns null.
* @see #acceptReadLocked(FailableConsumer)
* @see #applyWriteLocked(FailableFunction)
*/
@@ -389,8 +388,7 @@ public <T> T applyReadLocked(final FailableFunction<O, T,
?> function) {
* @param function The function, which is being invoked to compute the
result. The function will receive the
* hidden object.
* @return The result object, which has been returned by the functions
invocation.
- * @throws IllegalStateException The result object would be, in fact,
the hidden object. This would extend
- * access to the hidden object beyond this methods lifetime
and will therefore be prevented.
+ * @throws NullPointerException Thrown if the lock supplier is null or
returns null.
* @see #acceptReadLocked(FailableConsumer)
* @see #applyWriteLocked(FailableFunction)
*/
@@ -447,8 +445,7 @@ protected void lockAcceptUnlock(final Supplier<Lock>
lockSupplier, final Failabl
* @param function The function, which is being invoked to compute the
result object. This function will receive
* The object to protect as a parameter.
* @return The result object, which has been returned by the functions
invocation.
- * @throws IllegalStateException The result object would be, in fact,
the hidden object. This would extend
- * access to the hidden object beyond this methods lifetime
and will therefore be prevented.
+ * @throws NullPointerException Thrown if the lock supplier is null or
returns null.
* @see #applyReadLocked(FailableFunction)
* @see #applyWriteLocked(FailableFunction)
*/
