Skip to content

add an @apiNote to LockAcquisitionException and LockTimeoutException #9949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2025
+14 −0
Merged

add an @apiNote to LockAcquisitionException and LockTimeoutException #9949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions hibernate-core/src/main/java/org/hibernate/exception/LockAcquisitionException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
* A {@link JDBCException} indicating a problem acquiring a lock
* on the database.
*
* @apiNote Some databases make it quite hard to for a client to
* distinguish a {@linkplain LockTimeoutException lock timeout}
* from other sorts of rejected lock acquisitions, and so
* application programs should not over-interpret the distinction
* made between {@code LockAcquisitionException} and its subclass
* {@link LockTimeoutException} on such platforms.
*
* @author Steve Ebersole
*/
public class LockAcquisitionException extends PessimisticLockException {
Expand Down
7 changes: 7 additions & 0 deletions hibernate-core/src/main/java/org/hibernate/exception/LockTimeoutException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
* A {@link JDBCException} indicating that a {@linkplain org.hibernate.LockMode lock}
* request timed out on the database.
*
* @apiNote Some databases make it quite hard to for a client
* to distinguish a lock timeout from other sorts of rejected
* lock acquisitions, and so application programs should avoid
* over-interpreting the distinction made between
* {@code LockTimeoutException} and its superclass
* {@link LockAcquisitionException} on such platforms.
*
* @author Steve Ebersole
*
* @see org.hibernate.LockOptions#getTimeOut
Expand Down