8356553: Incorrect uses of {@link} in AbstractQueuedLongSynchronizer and AbstractQueuedSynchronizer

Reviewed-by: alanb
This commit is contained in:
Viktor Klang 2025-05-28 14:23:23 +00:00
parent 1a65719ab3
commit 18285fc136
2 changed files with 24 additions and 23 deletions

View File

@ -1303,8 +1303,8 @@ public abstract class AbstractQueuedLongSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled. * <li>Block until signalled.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(long)} with saved state as argument.
* </ol> * </ol>
*/ */
public final void awaitUninterruptibly() { public final void awaitUninterruptibly() {
@ -1346,8 +1346,8 @@ public abstract class AbstractQueuedLongSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled or interrupted. * <li>Block until signalled or interrupted.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(long)} with saved state as argument.
* <li>If interrupted while blocked in step 4, throw InterruptedException. * <li>If interrupted while blocked in step 4, throw InterruptedException.
* </ol> * </ol>
*/ */
@ -1398,8 +1398,8 @@ public abstract class AbstractQueuedLongSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled, interrupted, or timed out. * <li>Block until signalled, interrupted, or timed out.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(long)} with saved state as argument.
* <li>If interrupted while blocked in step 4, throw InterruptedException. * <li>If interrupted while blocked in step 4, throw InterruptedException.
* </ol> * </ol>
*/ */
@ -1442,8 +1442,8 @@ public abstract class AbstractQueuedLongSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled, interrupted, or timed out. * <li>Block until signalled, interrupted, or timed out.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(long)} with saved state as argument.
* <li>If interrupted while blocked in step 4, throw InterruptedException. * <li>If interrupted while blocked in step 4, throw InterruptedException.
* <li>If timed out while blocked in step 4, return false, else true. * <li>If timed out while blocked in step 4, return false, else true.
* </ol> * </ol>
@ -1485,8 +1485,8 @@ public abstract class AbstractQueuedLongSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled, interrupted, or timed out. * <li>Block until signalled, interrupted, or timed out.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(long)} with saved state as argument.
* <li>If interrupted while blocked in step 4, throw InterruptedException. * <li>If interrupted while blocked in step 4, throw InterruptedException.
* <li>If timed out while blocked in step 4, return false, else true. * <li>If timed out while blocked in step 4, return false, else true.
* </ol> * </ol>

View File

@ -86,9 +86,10 @@ import jdk.internal.misc.Unsafe;
* #isHeldExclusively} reports whether synchronization is exclusively * #isHeldExclusively} reports whether synchronization is exclusively
* held with respect to the current thread, method {@link #release} * held with respect to the current thread, method {@link #release}
* invoked with the current {@link #getState} value fully releases * invoked with the current {@link #getState} value fully releases
* this object, and {@link #acquire}, given this saved state value, * this object, and the underlying version of {@link #acquire(int)},
* eventually restores this object to its previous acquired state. No * given this saved state value, eventually restores this object to
* {@code AbstractQueuedSynchronizer} method otherwise creates such a * its previous acquired state.
* No {@code AbstractQueuedSynchronizer} method otherwise creates such a
* condition, so if this constraint cannot be met, do not use it. The * condition, so if this constraint cannot be met, do not use it. The
* behavior of {@link ConditionObject} depends of course on the * behavior of {@link ConditionObject} depends of course on the
* semantics of its synchronizer implementation. * semantics of its synchronizer implementation.
@ -1682,8 +1683,8 @@ public abstract class AbstractQueuedSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled. * <li>Block until signalled.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(int)} with saved state as argument.
* </ol> * </ol>
*/ */
public final void awaitUninterruptibly() { public final void awaitUninterruptibly() {
@ -1725,8 +1726,8 @@ public abstract class AbstractQueuedSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled or interrupted. * <li>Block until signalled or interrupted.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(int)} with saved state as argument.
* <li>If interrupted while blocked in step 4, throw InterruptedException. * <li>If interrupted while blocked in step 4, throw InterruptedException.
* </ol> * </ol>
*/ */
@ -1777,8 +1778,8 @@ public abstract class AbstractQueuedSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled, interrupted, or timed out. * <li>Block until signalled, interrupted, or timed out.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(int)} with saved state as argument.
* <li>If interrupted while blocked in step 4, throw InterruptedException. * <li>If interrupted while blocked in step 4, throw InterruptedException.
* </ol> * </ol>
*/ */
@ -1821,8 +1822,8 @@ public abstract class AbstractQueuedSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled, interrupted, or timed out. * <li>Block until signalled, interrupted, or timed out.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(int)} with saved state as argument.
* <li>If interrupted while blocked in step 4, throw InterruptedException. * <li>If interrupted while blocked in step 4, throw InterruptedException.
* <li>If timed out while blocked in step 4, return false, else true. * <li>If timed out while blocked in step 4, return false, else true.
* </ol> * </ol>
@ -1864,8 +1865,8 @@ public abstract class AbstractQueuedSynchronizer
* <li>Invoke {@link #release} with saved state as argument, * <li>Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails. * throwing IllegalMonitorStateException if it fails.
* <li>Block until signalled, interrupted, or timed out. * <li>Block until signalled, interrupted, or timed out.
* <li>Reacquire by invoking specialized version of * <li>Reacquire by invoking underlying version of
* {@link #acquire} with saved state as argument. * {@link #acquire(int)} with saved state as argument.
* <li>If interrupted while blocked in step 4, throw InterruptedException. * <li>If interrupted while blocked in step 4, throw InterruptedException.
* <li>If timed out while blocked in step 4, return false, else true. * <li>If timed out while blocked in step 4, return false, else true.
* </ol> * </ol>