HHH-15069 Fix backwards-incompatible changes for implementors of UniqueDelegate

Author: yrodiere

hibernate-core/src/main/java/org/hibernate/dialect/unique/UniqueDelegate.java

@@ -35,6 +35,21 @@
  * @author Brett Meyer
  */
 public interface UniqueDelegate {
+	/**
+	 * Get the fragment that can be used to make a column unique as part of its column definition.
+	 * <p/>
+	 * This is intended for dialects which do not support unique constraints
+	 *
+	 * @param column The column to which to apply the unique
+	 * @return The fragment (usually "unique"), empty string indicates the uniqueness will be indicated using a
+	 * different approach
+	 * @deprecated Implement {@link #getColumnDefinitionUniquenessFragment(Column, SqlStringGenerationContext)} instead.
+	 */
+	@Deprecated
+	default String getColumnDefinitionUniquenessFragment(Column column) {
+		throw new IllegalStateException("getColumnDefinitionUniquenessFragment(...) was not implemented!");
+	}
+
 	/**
 	 * Get the fragment that can be used to make a column unique as part of its column definition.
 	 * <p/>
@@ -45,7 +60,27 @@ public interface UniqueDelegate {
 	 * @return The fragment (usually "unique"), empty string indicates the uniqueness will be indicated using a
 	 * different approach
 	 */
-	public String getColumnDefinitionUniquenessFragment(Column column, SqlStringGenerationContext context);
+	default String getColumnDefinitionUniquenessFragment(Column column, SqlStringGenerationContext context) {
+		return getColumnDefinitionUniquenessFragment( column );
+	}
+
+	/**
+	 * Get the fragment that can be used to apply unique constraints as part of table creation.  The implementation
+	 * should iterate over the {@link org.hibernate.mapping.UniqueKey} instances for the given table (see
+	 * {@link org.hibernate.mapping.Table#getUniqueKeyIterator()} and generate the whole fragment for all
+	 * unique keys
+	 * <p/>
+	 * Intended for Dialects which support unique constraint definitions, but just not in separate ALTER statements.
+	 *
+	 * @param table The table for which to generate the unique constraints fragment
+	 * @return The fragment, typically in the form {@code ", unique(col1, col2), unique( col20)"}.  NOTE: The leading
+	 * comma is important!
+	 * @deprecated Implement {@link #getTableCreationUniqueConstraintsFragment(Table, SqlStringGenerationContext)} instead.
+	 */
+	@Deprecated
+	default String getTableCreationUniqueConstraintsFragment(Table table) {
+		throw new IllegalStateException("getTableCreationUniqueConstraintsFragment(...) was not implemented!");
+	}
 
 	/**
 	 * Get the fragment that can be used to apply unique constraints as part of table creation.  The implementation
@@ -60,7 +95,22 @@ public interface UniqueDelegate {
 	 * @return The fragment, typically in the form {@code ", unique(col1, col2), unique( col20)"}.  NOTE: The leading
 	 * comma is important!
 	 */
-	public String getTableCreationUniqueConstraintsFragment(Table table, SqlStringGenerationContext context);
+	default String getTableCreationUniqueConstraintsFragment(Table table, SqlStringGenerationContext context) {
+		return getTableCreationUniqueConstraintsFragment( table );
+	}
+
+	/**
+	 * Get the SQL ALTER TABLE command to be used to create the given UniqueKey.
+	 *
+	 * @param uniqueKey The UniqueKey instance.  Contains all information about the columns
+	 * @param metadata Access to the bootstrap mapping information
+	 * @return The ALTER TABLE command
+	 * @deprecated Implement {@link #getAlterTableToAddUniqueKeyCommand(UniqueKey, Metadata, SqlStringGenerationContext)} instead.
+	 */
+	@Deprecated
+	default String getAlterTableToAddUniqueKeyCommand(UniqueKey uniqueKey, Metadata metadata) {
+		throw new IllegalStateException("getAlterTableToAddUniqueKeyCommand(...) was not implemented!");
+	}
 
 	/**
 	 * Get the SQL ALTER TABLE command to be used to create the given UniqueKey.
@@ -70,8 +120,23 @@ public interface UniqueDelegate {
 	 * @param context A context for SQL string generation
 	 * @return The ALTER TABLE command
 	 */
-	public String getAlterTableToAddUniqueKeyCommand(UniqueKey uniqueKey, Metadata metadata,
-			SqlStringGenerationContext context);
+	default String getAlterTableToAddUniqueKeyCommand(UniqueKey uniqueKey, Metadata metadata,
+			SqlStringGenerationContext context) {
+		return getAlterTableToAddUniqueKeyCommand( uniqueKey, metadata );
+	}
+
+	/**
+	 * Get the SQL ALTER TABLE command to be used to drop the given UniqueKey.
+	 *
+	 * @param uniqueKey The UniqueKey instance.  Contains all information about the columns
+	 * @param metadata Access to the bootstrap mapping information
+	 * @return The ALTER TABLE command
+	 * @deprecated Implement {@link #getAlterTableToDropUniqueKeyCommand(UniqueKey, Metadata, SqlStringGenerationContext)} instead.
+	 */
+	@Deprecated
+	default String getAlterTableToDropUniqueKeyCommand(UniqueKey uniqueKey, Metadata metadata) {
+		throw new IllegalStateException("getAlterTableToDropUniqueKeyCommand(...) was not implemented!");
+	}
 
 	/**
 	 * Get the SQL ALTER TABLE command to be used to drop the given UniqueKey.
@@ -81,7 +146,9 @@ public String getAlterTableToAddUniqueKeyCommand(UniqueKey uniqueKey, Metadata m
 	 * @param context A context for SQL string generation
 	 * @return The ALTER TABLE command
 	 */
-	public String getAlterTableToDropUniqueKeyCommand(UniqueKey uniqueKey, Metadata metadata,
-			SqlStringGenerationContext context);
+	default String getAlterTableToDropUniqueKeyCommand(UniqueKey uniqueKey, Metadata metadata,
+			SqlStringGenerationContext context) {
+		return getAlterTableToDropUniqueKeyCommand( uniqueKey, metadata );
+	}
 
 }