rename a confusingly-named method

Author: gavinking

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/H2LegacyDialect.java

@@ -952,7 +952,7 @@ public int registerResultSetOutParameter(CallableStatement statement, int positi
 
 	@Override
 	public String getQueryHintString(String query, String hints) {
-		return addQueryHints( query, hints );
+		return addUseIndexQueryHint( query, hints );
 	}
 
 	@Override

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/MySQLLegacyDialect.java

@@ -884,7 +884,7 @@ public String getEnumTypeDeclaration(String name, String[] values) {
 	public String getQueryHintString(String query, String hints) {
 		return getMySQLVersion().isBefore( 5 )
 				? super.getQueryHintString( query, hints )
-				: addQueryHints( query, hints );
+				: addUseIndexQueryHint( query, hints );
 	}
 
 	/**

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SingleStoreDialect.java

@@ -406,7 +406,7 @@ public String getEnumTypeDeclaration(String name, String[] values) {
 
 	@Override
 	public String getQueryHintString(String query, String hints) {
-		return addQueryHints( query, hints );
+		return addUseIndexQueryHint( query, hints );
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java

@@ -205,10 +205,12 @@
 
 import static java.lang.Math.ceil;
 import static java.lang.Math.log;
+import static java.lang.String.join;
 import static org.hibernate.cfg.AvailableSettings.NON_CONTEXTUAL_LOB_CREATION;
 import static org.hibernate.cfg.AvailableSettings.STATEMENT_BATCH_SIZE;
 import static org.hibernate.cfg.AvailableSettings.USE_GET_GENERATED_KEYS;
 import static org.hibernate.internal.util.MathHelper.ceilingPowerOfTwo;
+import static org.hibernate.internal.util.StringHelper.isEmpty;
 import static org.hibernate.internal.util.StringHelper.splitAtCommas;
 import static org.hibernate.internal.util.collections.ArrayHelper.EMPTY_STRING_ARRAY;
 import static org.hibernate.type.SqlTypes.*;
@@ -2736,13 +2738,13 @@ public String getAddForeignKeyConstraintString(
 		res.append( " add constraint " )
 				.append( quote( constraintName ) )
 				.append( " foreign key (" )
-				.append( String.join( ", ", foreignKey ) )
+				.append( join( ", ", foreignKey ) )
 				.append( ") references " )
 				.append( referencedTable );
 
 		if ( !referencesPrimaryKey ) {
 			res.append( " (" )
-					.append( String.join( ", ", primaryKey ) )
+					.append( join( ", ", primaryKey ) )
 					.append( ')' );
 		}
 
@@ -4161,8 +4163,13 @@ public UniqueDelegate getUniqueDelegate() {
 	 * @return The modified SQL
 	 */
 	public String getQueryHintString(String query, List<String> hintList) {
-		final String hints = String.join( ", ", hintList );
-		return StringHelper.isEmpty( hints ) ? query : getQueryHintString( query, hints);
+		if ( hintList.isEmpty() ) {
+			return query;
+		}
+		else {
+			final String hints = join( ", ", hintList );
+			return isEmpty( hints ) ? query : getQueryHintString( query, hints );
+		}
 	}
 
 	/**
@@ -4745,12 +4752,12 @@ public boolean useMaterializedLobWhenCapacityExceeded() {
 	}
 
 	/**
-	 * Modify the SQL, adding hints or comments, if necessary
+	 * Modify the SQL, adding hints or comments, if necessary.
+	 *
+	 * @see #getQueryHintString(String,List)
+	 * @see #prependComment
 	 */
-	public String addSqlHintOrComment(
-			String sql,
-			QueryOptions queryOptions,
-			boolean commentsEnabled) {
+	public String addSqlHintOrComment(String sql, QueryOptions queryOptions, boolean commentsEnabled) {
 		// Keep this here, rather than moving to Select.
 		// Some Dialects may need the hint to be appended to the very end or beginning
 		// of the finalized SQL statement, so wait until everything is processed.
@@ -4764,29 +4771,25 @@ public String addSqlHintOrComment(
 	}
 
 	/**
-	 * Adds an INDEX query hint as follows:
+	 * Adds an {@code INDEX} query hint as follows:
 	 *
 	 * <pre>
 	 * SELECT *
 	 * FROM TEST
 	 * USE INDEX (hint1, hint2)
 	 * WHERE X=1
 	 * </pre>
+	 *
+	 * @since 7.0
 	 */
-	public static String addQueryHints(String query, String hints) {
-		Matcher matcher = QUERY_PATTERN.matcher( query );
+	public static String addUseIndexQueryHint(String query, String hints) {
+		final Matcher matcher = QUERY_PATTERN.matcher( query );
 		if ( matcher.matches() && matcher.groupCount() > 1 ) {
 			final String startToken = matcher.group(1);
 			// Null if there is no join in the query
-			final String joinToken = Objects.toString(matcher.group(2), "");
+			final String joinToken = Objects.toString( matcher.group(2), "" );
 			final String endToken = matcher.group(3);
-
-			return startToken +
-					" use index (" +
-					hints +
-					") " +
-					joinToken +
-					endToken;
+			return startToken + " use index (" + hints + ") " + joinToken + endToken;
 		}
 		else {
 			return query;

hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java

@@ -935,7 +935,7 @@ public int registerResultSetOutParameter(CallableStatement statement, int positi
 
 	@Override
 	public String getQueryHintString(String query, String hints) {
-		return addQueryHints( query, hints );
+		return addUseIndexQueryHint( query, hints );
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/dialect/MySQLDialect.java

@@ -959,7 +959,7 @@ public String getEnumTypeDeclaration(String name, String[] values) {
 
 	@Override
 	public String getQueryHintString(String query, String hints) {
-		return addQueryHints( query, hints );
+		return addUseIndexQueryHint( query, hints );
 	}
 
 	/**

hibernate-core/src/main/java/org/hibernate/dialect/hint/IndexQueryHintHandler.java

@@ -14,6 +14,6 @@ public class IndexQueryHintHandler implements QueryHintHandler {
 
 	@Override
 	public String addQueryHints(String query, String hints) {
-		return Dialect.addQueryHints( query, hints);
+		return Dialect.addUseIndexQueryHint( query, hints);
 	}
 }

hibernate-core/src/main/java/org/hibernate/query/internal/QueryOptionsImpl.java

@@ -5,7 +5,6 @@
 package org.hibernate.query.internal;
 
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
@@ -24,6 +23,8 @@
 import org.hibernate.query.spi.Limit;
 import org.hibernate.query.spi.MutableQueryOptions;
 
+import static java.util.Collections.emptyList;
+
 /**
  * @author Steve Ebersole
  */
@@ -83,7 +84,7 @@ public void setComment(String comment) {
 
 	@Override
 	public List<String> getDatabaseHints() {
-		return databaseHints == null ? Collections.emptyList() : databaseHints;
+		return databaseHints == null ? emptyList() : databaseHints;
 	}
 
 	@Override

hibernate-core/src/test/java/org/hibernate/dialect/DialectTest.java

@@ -46,7 +46,7 @@ static Stream<Arguments> _addQueryHints() {
 	@MethodSource("_addQueryHints")
 	@ParameterizedTest
 	void addQueryHints(String description, String expected, String query, String hints) {
-		final String queryWithHint = MySQLDialect.addQueryHints(query, hints);
+		final String queryWithHint = MySQLDialect.addUseIndexQueryHint(query, hints);
 		assertEquals(expected, queryWithHint, description);
 	}