HHH-19440 - Deprecate exposing of LockOptions

sebersole · sebersole · commit 7d43ce80a1de · 2025-05-11T11:43:53.000-05:00
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/HANALegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/HANALegacyDialect.java
@@ -1041,8 +1041,8 @@ public String getReadLockString(String aliases, int timeout) {
 
 	@Override
 	public String getWriteLockString(int timeout) {
-		if ( timeout > 0 ) {
-			return getForUpdateString() + " wait " + getTimeoutInSeconds( timeout );
+		if ( Timeouts.isRealTimeout( timeout ) ) {
+			return getForUpdateString() + " wait " + Timeouts.getTimeoutInSeconds( timeout );
 		}
 		else if ( timeout == Timeouts.NO_WAIT_MILLI ) {
 			return getForUpdateNowaitString();
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/MySQLLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/MySQLLegacyDialect.java
@@ -1338,7 +1338,12 @@ public static Replacer datetimeFormat(String format) {
 	}
 
 	private String withTimeout(String lockString, Timeout timeout) {
-		return withTimeout( lockString, Timeouts.getTimeoutInSeconds( timeout ) );
+		return switch ( timeout.milliseconds() ) {
+			case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;
+			case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;
+			case Timeouts.WAIT_FOREVER_MILLI -> lockString;
+			default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;
+		};
 	}
 
 	@Override
@@ -1372,7 +1377,7 @@ private String withTimeout(String lockString, int timeout) {
 			case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;
 			case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;
 			case Timeouts.WAIT_FOREVER_MILLI -> lockString;
-			default -> supportsWait() ? lockString + " wait " + getTimeoutInSeconds( timeout ) : lockString;
+			default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;
 		};
 	}
 
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/OracleLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/OracleLegacyDialect.java
@@ -1440,7 +1440,7 @@ private String withTimeout(String lockString, int timeout) {
 			case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;
 			case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;
 			case Timeouts.WAIT_FOREVER_MILLI -> lockString;
-			default -> supportsWait() ? lockString + " wait " + getTimeoutInSeconds( timeout ) : lockString;
+			default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;
 		};
 	}
 
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/TiDBDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/TiDBDialect.java
@@ -205,8 +205,8 @@ public String getWriteLockString(int timeout) {
 			return getForUpdateNowaitString();
 		}
 
-		if ( timeout > 0 ) {
-			return getForUpdateString() + " wait " + getTimeoutInSeconds( timeout );
+		if ( Timeouts.isRealTimeout( timeout ) ) {
+			return getForUpdateString() + " wait " + Timeouts.getTimeoutInSeconds( timeout );
 		}
 
 		return getForUpdateString();
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java
@@ -2563,6 +2563,10 @@ public String applyLocksToSql(String sql, LockOptions aliasedLockOptions, Map<St
 		return sql + new ForUpdateFragment( this, aliasedLockOptions, keyColumnNames ).toFragmentString();
 	}
 
+	/**
+	 * @deprecated Use {@linkplain Timeouts#getTimeoutInSeconds(int)} instead.
+	 */
+	@Deprecated
 	protected int getTimeoutInSeconds(int millis) {
 		return Timeouts.getTimeoutInSeconds( millis );
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/HANADialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/HANADialect.java
@@ -1017,7 +1017,7 @@ public String getReadLockString(String aliases, Timeout timeout) {
 	@Override
 	public String getWriteLockString(Timeout timeout) {
 		if ( Timeouts.isRealTimeout( timeout ) ) {
-			return getForUpdateString() + " wait " + getTimeoutInSeconds( timeout.milliseconds() );
+			return getForUpdateString() + " wait " + Timeouts.getTimeoutInSeconds( timeout.milliseconds() );
 		}
 		else if ( timeout.milliseconds() == Timeouts.NO_WAIT_MILLI ) {
 			return getForUpdateNowaitString();
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/MySQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/MySQLDialect.java
@@ -1434,7 +1434,12 @@ public static Replacer datetimeFormat(String format) {
 	}
 
 	private String withTimeout(String lockString, Timeout timeout) {
-		return withTimeout( lockString, Timeouts.getTimeoutInSeconds( timeout ) );
+		return switch (timeout.milliseconds()) {
+			case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;
+			case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;
+			case Timeouts.WAIT_FOREVER_MILLI -> lockString;
+			default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;
+		};
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java
@@ -1494,7 +1494,7 @@ private String withTimeout(String lockString, int timeout) {
 			case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;
 			case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;
 			case Timeouts.WAIT_FOREVER_MILLI -> lockString;
-			default -> supportsWait() ? lockString + " wait " + getTimeoutInSeconds( timeout ) : lockString;
+			default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;
 		};
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -1338,7 +1338,12 @@ public static Replacer datetimeFormat(String format) {`
`1338`	`1338`	`}`
`1339`	`1339`
`1340`	`1340`	`private String withTimeout(String lockString, Timeout timeout) {`
`1341`		`- return withTimeout( lockString, Timeouts.getTimeoutInSeconds( timeout ) );`
	`1341`	`+ return switch ( timeout.milliseconds() ) {`
	`1342`	`+ case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;`
	`1343`	`+ case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;`
	`1344`	`+ case Timeouts.WAIT_FOREVER_MILLI -> lockString;`
	`1345`	`+ default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;`
	`1346`	`+ };`
`1342`	`1347`	`}`
`1343`	`1348`
`1344`	`1349`	`@Override`
`@@ -1372,7 +1377,7 @@ private String withTimeout(String lockString, int timeout) {`
`1372`	`1377`	`case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;`
`1373`	`1378`	`case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;`
`1374`	`1379`	`case Timeouts.WAIT_FOREVER_MILLI -> lockString;`
`1375`		`- default -> supportsWait() ? lockString + " wait " + getTimeoutInSeconds( timeout ) : lockString;`
	`1380`	`+ default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;`
`1376`	`1381`	`};`
`1377`	`1382`	`}`
`1378`	`1383`
Original file line number	Diff line number	Diff line change
`@@ -1440,7 +1440,7 @@ private String withTimeout(String lockString, int timeout) {`
`1440`	`1440`	`case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;`
`1441`	`1441`	`case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;`
`1442`	`1442`	`case Timeouts.WAIT_FOREVER_MILLI -> lockString;`
`1443`		`- default -> supportsWait() ? lockString + " wait " + getTimeoutInSeconds( timeout ) : lockString;`
	`1443`	`+ default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;`
`1444`	`1444`	`};`
`1445`	`1445`	`}`
`1446`	`1446`
Original file line number	Diff line number	Diff line change
`@@ -205,8 +205,8 @@ public String getWriteLockString(int timeout) {`
`205`	`205`	`return getForUpdateNowaitString();`
`206`	`206`	`}`
`207`	`207`
`208`		`- if ( timeout > 0 ) {`
`209`		`- return getForUpdateString() + " wait " + getTimeoutInSeconds( timeout );`
	`208`	`+ if ( Timeouts.isRealTimeout( timeout ) ) {`
	`209`	`+ return getForUpdateString() + " wait " + Timeouts.getTimeoutInSeconds( timeout );`
`210`	`210`	`}`
`211`	`211`
`212`	`212`	`return getForUpdateString();`
Original file line number	Diff line number	Diff line change
`@@ -2563,6 +2563,10 @@ public String applyLocksToSql(String sql, LockOptions aliasedLockOptions, Map<St`
`2563`	`2563`	`return sql + new ForUpdateFragment( this, aliasedLockOptions, keyColumnNames ).toFragmentString();`
`2564`	`2564`	`}`
`2565`	`2565`
	`2566`	`+ /**`
	`2567`	`+ * @deprecated Use {@linkplain Timeouts#getTimeoutInSeconds(int)} instead.`
	`2568`	`+ */`
	`2569`	`+ @Deprecated`
`2566`	`2570`	`protected int getTimeoutInSeconds(int millis) {`
`2567`	`2571`	`return Timeouts.getTimeoutInSeconds( millis );`
`2568`	`2572`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1017,7 +1017,7 @@ public String getReadLockString(String aliases, Timeout timeout) {`
`1017`	`1017`	`@Override`
`1018`	`1018`	`public String getWriteLockString(Timeout timeout) {`
`1019`	`1019`	`if ( Timeouts.isRealTimeout( timeout ) ) {`
`1020`		`- return getForUpdateString() + " wait " + getTimeoutInSeconds( timeout.milliseconds() );`
	`1020`	`+ return getForUpdateString() + " wait " + Timeouts.getTimeoutInSeconds( timeout.milliseconds() );`
`1021`	`1021`	`}`
`1022`	`1022`	`else if ( timeout.milliseconds() == Timeouts.NO_WAIT_MILLI ) {`
`1023`	`1023`	`return getForUpdateNowaitString();`
Original file line number	Diff line number	Diff line change
`@@ -1434,7 +1434,12 @@ public static Replacer datetimeFormat(String format) {`
`1434`	`1434`	`}`
`1435`	`1435`
`1436`	`1436`	`private String withTimeout(String lockString, Timeout timeout) {`
`1437`		`- return withTimeout( lockString, Timeouts.getTimeoutInSeconds( timeout ) );`
	`1437`	`+ return switch (timeout.milliseconds()) {`
	`1438`	`+ case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;`
	`1439`	`+ case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;`
	`1440`	`+ case Timeouts.WAIT_FOREVER_MILLI -> lockString;`
	`1441`	`+ default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;`
	`1442`	`+ };`
`1438`	`1443`	`}`
`1439`	`1444`
`1440`	`1445`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -1494,7 +1494,7 @@ private String withTimeout(String lockString, int timeout) {`
`1494`	`1494`	`case Timeouts.NO_WAIT_MILLI -> supportsNoWait() ? lockString + " nowait" : lockString;`
`1495`	`1495`	`case Timeouts.SKIP_LOCKED_MILLI -> supportsSkipLocked() ? lockString + " skip locked" : lockString;`
`1496`	`1496`	`case Timeouts.WAIT_FOREVER_MILLI -> lockString;`
`1497`		`- default -> supportsWait() ? lockString + " wait " + getTimeoutInSeconds( timeout ) : lockString;`
	`1497`	`+ default -> supportsWait() ? lockString + " wait " + Timeouts.getTimeoutInSeconds( timeout ) : lockString;`
`1498`	`1498`	`};`
`1499`	`1499`	`}`
`1500`	`1500`