Skip to content

Commit d1c121b

Browse files
committed
add useful @sees to jdoc for some exception types
1 parent 2e5a7f8 commit d1c121b

File tree

6 files changed

+18
-4
lines changed

6 files changed

+18
-4
lines changed

hibernate-core/src/main/java/org/hibernate/LazyInitializationException.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
*
2020
* @see Hibernate#initialize(Object)
2121
* @see Hibernate#isInitialized(Object)
22+
* @see StatelessSession#fetch(Object)
23+
*
2224
* @author Gavin King
2325
*/
2426
public class LazyInitializationException extends HibernateException {

hibernate-core/src/main/java/org/hibernate/NonUniqueResultException.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
* this one is recoverable!
1414
*
1515
* @author Gavin King
16+
*
17+
* @see jakarta.persistence.Query#getSingleResult
18+
* @see org.hibernate.query.SelectionQuery#getSingleResult
1619
*/
1720
public class NonUniqueResultException extends HibernateException {
1821

hibernate-core/src/main/java/org/hibernate/PropertySetterAccessException.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
import org.checkerframework.checker.nullness.qual.Nullable;
1212

1313
/**
14+
* Thrown when an {@link IllegalArgumentException} occurs calling a property setter method.
15+
*
1416
* @author Steve Ebersole
1517
*/
1618
public class PropertySetterAccessException extends PropertyAccessException {

hibernate-core/src/main/java/org/hibernate/QueryTimeoutException.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@
77
import java.sql.SQLException;
88

99
/**
10-
* Thrown when a database query timeout occurs.
10+
* A {@link JDBCException} indicating that a database query timed
11+
* out on the database.
1112
*
1213
* @author Scott Marlow
14+
*
15+
* @see jakarta.persistence.Query#setTimeout
16+
* @see org.hibernate.query.CommonQueryContract#setTimeout
1317
*/
1418
public class QueryTimeoutException extends JDBCException {
1519
/**

hibernate-core/src/main/java/org/hibernate/UnknownEntityTypeException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
/**
88
* Indicates an attempt was made to refer to an unknown entity name or class.
9-
* <p>
9+
*
1010
* @implNote This class extends {@link MappingException} for legacy reasons.
1111
* Longer term I think it makes more sense to have a different hierarchy for
1212
* runtime-"mapping" exceptions.

hibernate-core/src/main/java/org/hibernate/exception/LockTimeoutException.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,13 @@
99
import java.sql.SQLException;
1010

1111
/**
12-
* A {@link JDBCException} indicating that a lock request
13-
* timed out on the database.
12+
* A {@link JDBCException} indicating that a {@linkplain org.hibernate.LockMode lock}
13+
* request timed out on the database.
1414
*
1515
* @author Steve Ebersole
16+
*
17+
* @see org.hibernate.LockOptions#getTimeOut
18+
* @see org.hibernate.LockOptions#setTimeOut
1619
*/
1720
public class LockTimeoutException extends LockAcquisitionException {
1821
public LockTimeoutException(String string, SQLException root) {

0 commit comments

Comments
 (0)