HHH-18843 remove deprecated @orderby

Author: gavinking

documentation/src/main/asciidoc/userguide/chapters/domain/collections.adoc

@@ -156,7 +156,7 @@ after the collection is loaded, the collection would need to be refreshed to re-
 the elements.  For this reason, ordered sets are not recommended - if the application
 needs ordering of the set elements, a sorted set should be preferred.  For this reason,
 it is not covered in the User Guide.  See the javadocs for `jakarta.persistence.OrderBy`
-or `org.hibernate.annotations.OrderBy` for details.
+or `org.hibernate.annotations.SQLOrder` for details.
 
 There are 2 options for sorting a set - naturally or using an explicit comparator.
 

hibernate-core/src/main/java/org/hibernate/annotations/DialectOverride.java

@@ -90,33 +90,6 @@ public interface DialectOverride {
 		Check[] value();
 	}
 
-	/**
-	 * Specializes an {@link org.hibernate.annotations.OrderBy}
-	 * in a certain dialect.
-	 *
-	 * @deprecated Use {@link SQLOrder}
-	 */
-	@Target({METHOD, FIELD})
-	@Retention(RUNTIME)
-	@Repeatable(OrderBys.class)
-	@OverridesAnnotation(org.hibernate.annotations.OrderBy.class)
-	@Deprecated(since = "6.3", forRemoval = true)
-	@interface OrderBy {
-		/**
-		 * The {@link Dialect} in which this override applies.
-		 */
-		Class<? extends Dialect> dialect();
-		Version before() default @Version(major = MAX_VALUE);
-		Version sameOrAfter() default @Version(major = MIN_VALUE);
-
-		org.hibernate.annotations.OrderBy override();
-	}
-	@Target({METHOD, FIELD})
-	@Retention(RUNTIME)
-	@interface OrderBys {
-		OrderBy[] value();
-	}
-
 	/**
 	 * Specializes an {@link org.hibernate.annotations.SQLOrder}
 	 * in a certain dialect.

hibernate-core/src/main/java/org/hibernate/annotations/OrderBy.java

@@ -237,7 +237,6 @@ public abstract class CollectionBinder {
 	private boolean hibernateExtensionMapping;
 
 	private jakarta.persistence.OrderBy jpaOrderBy;
-	private org.hibernate.annotations.OrderBy sqlOrderBy;
 	private SQLOrder sqlOrder;
 	private SortNatural naturalSort;
 	private SortComparator comparatorSort;
@@ -287,7 +286,6 @@ public static void bindCollection(
 		collectionBinder.setMapKey( property.getAnnotationUsage( MapKey.class, sourceModelContext ) );
 		collectionBinder.setPropertyName( inferredData.getPropertyName() );
 		collectionBinder.setJpaOrderBy( property.getAnnotationUsage( OrderBy.class, sourceModelContext ) );
-		collectionBinder.setSqlOrderBy( getOverridableAnnotation( property, org.hibernate.annotations.OrderBy.class, context ) );
 		collectionBinder.setSqlOrder( getOverridableAnnotation( property, SQLOrder.class, context ) );
 		collectionBinder.setNaturalSort( property.getAnnotationUsage( SortNatural.class, sourceModelContext ) );
 		collectionBinder.setComparatorSort( property.getAnnotationUsage( SortComparator.class, sourceModelContext ) );
@@ -841,11 +839,6 @@ public void setJpaOrderBy(jakarta.persistence.OrderBy jpaOrderBy) {
 		this.jpaOrderBy = jpaOrderBy;
 	}
 
-	@SuppressWarnings("removal")
-	public void setSqlOrderBy(org.hibernate.annotations.OrderBy sqlOrderBy) {
-		this.sqlOrderBy = sqlOrderBy;
-	}
-
 	public void setSqlOrder(SQLOrder sqlOrder) {
 		this.sqlOrder = sqlOrder;
 	}
@@ -1095,7 +1088,7 @@ private static CollectionClassification determineCollectionClassification(
 			}
 
 			if ( property.hasDirectAnnotationUsage( jakarta.persistence.OrderBy.class )
-					|| property.hasDirectAnnotationUsage( org.hibernate.annotations.OrderBy.class ) ) {
+					|| property.hasDirectAnnotationUsage( org.hibernate.annotations.SQLOrder.class ) ) {
 				return CollectionClassification.BAG;
 			}
 
@@ -1443,15 +1436,12 @@ else if ( comparatorSort != null ) {
 			comparatorClass = null;
 		}
 
-		if ( jpaOrderBy != null && ( sqlOrderBy != null || sqlOrder != null ) ) {
+		if ( jpaOrderBy != null && sqlOrder != null ) {
 			throw buildIllegalOrderCombination();
 		}
-		boolean ordered = jpaOrderBy != null || sqlOrderBy != null || sqlOrder != null ;
+		final boolean ordered = jpaOrderBy != null || sqlOrder != null ;
 		if ( ordered ) {
 			// we can only apply the sql-based order by up front.  The jpa order by has to wait for second pass
-			if ( sqlOrderBy != null ) {
-				collection.setOrderBy( sqlOrderBy.clause() );
-			}
 			if ( sqlOrder != null ) {
 				collection.setOrderBy( sqlOrder.value() );
 			}
@@ -1490,7 +1480,7 @@ private AnnotationException buildIllegalOrderCombination() {
 						"Collection '%s' is annotated both '@%s' and '@%s'",
 						safeCollectionRole(),
 						jakarta.persistence.OrderBy.class.getName(),
-						org.hibernate.annotations.OrderBy.class.getName()
+						org.hibernate.annotations.SQLOrder.class.getName()
 				)
 		);
 	}
@@ -1502,7 +1492,7 @@ private AnnotationException buildIllegalOrderAndSortCombination() {
 						"Collection '%s' is both sorted and ordered (only one of '@%s', '@%s', '@%s', and '@%s' may be used)",
 						safeCollectionRole(),
 						jakarta.persistence.OrderBy.class.getName(),
-						org.hibernate.annotations.OrderBy.class.getName(),
+						org.hibernate.annotations.SQLOrder.class.getName(),
 						SortComparator.class.getName(),
 						SortNatural.class.getName()
 				)

hibernate-core/src/main/java/org/hibernate/boot/model/internal/CollectionBinder.java

@@ -7,9 +7,7 @@
 import java.util.Map;
 import java.util.function.Supplier;
 
-import org.hibernate.AnnotationException;
 import org.hibernate.MappingException;
-import org.hibernate.annotations.OrderBy;
 import org.hibernate.boot.spi.MetadataBuildingContext;
 import org.hibernate.boot.spi.SecondPass;
 import org.hibernate.mapping.Collection;
@@ -47,13 +45,6 @@ protected Collection createCollection(PersistentClass owner) {
 		return new List( getCustomTypeBeanResolver(), owner, getBuildingContext() );
 	}
 
-	@Override
-	public void setSqlOrderBy(OrderBy orderByAnn) {
-		if ( orderByAnn != null ) {
-			throw new AnnotationException( "A collection of type 'List' is annotated '@OrderBy'" );
-		}
-	}
-
 	@Override
 	public SecondPass getSecondPass() {
 		return new CollectionSecondPass( ListBinder.this.collection ) {

hibernate-core/src/main/java/org/hibernate/boot/model/internal/ListBinder.java

@@ -6,7 +6,6 @@
 
 import java.util.function.Supplier;
 
-import org.hibernate.annotations.OrderBy;
 import org.hibernate.boot.spi.MetadataBuildingContext;
 import org.hibernate.mapping.Collection;
 import org.hibernate.mapping.PersistentClass;
@@ -34,10 +33,4 @@ protected Collection createCollection(PersistentClass persistentClass) {
 		return new Set( getCustomTypeBeanResolver(), persistentClass, getBuildingContext() );
 	}
 
-	@Override
-	public void setSqlOrderBy(OrderBy orderByAnn) {
-		if ( orderByAnn != null ) {
-			super.setSqlOrderBy( orderByAnn );
-		}
-	}
 }

hibernate-core/src/main/java/org/hibernate/boot/model/internal/SetBinder.java

@@ -27,8 +27,6 @@
 import org.hibernate.boot.models.annotations.internal.OverriddenGeneratedColumnsAnnotation;
 import org.hibernate.boot.models.annotations.internal.OverriddenJoinFormulaAnnotation;
 import org.hibernate.boot.models.annotations.internal.OverriddenJoinFormulasAnnotation;
-import org.hibernate.boot.models.annotations.internal.OverriddenOrderByAnnotation;
-import org.hibernate.boot.models.annotations.internal.OverriddenOrderBysAnnotation;
 import org.hibernate.boot.models.annotations.internal.OverriddenSQLDeleteAllAnnotation;
 import org.hibernate.boot.models.annotations.internal.OverriddenSQLDeleteAllsAnnotation;
 import org.hibernate.boot.models.annotations.internal.OverriddenSQLDeleteAnnotation;
@@ -61,15 +59,6 @@ public interface DialectOverrideAnnotations {
 			OverriddenCheckAnnotation.class,
 			DIALECT_OVERRIDE_CHECKS
 	);
-	OrmAnnotationDescriptor<DialectOverride.OrderBys, OverriddenOrderBysAnnotation> DIALECT_OVERRIDE_ORDER_BYS = new OrmAnnotationDescriptor<>(
-			DialectOverride.OrderBys.class,
-			OverriddenOrderBysAnnotation.class
-	);
-	OrmAnnotationDescriptor<DialectOverride.OrderBy, OverriddenOrderByAnnotation> DIALECT_OVERRIDE_ORDER_BY = new OrmAnnotationDescriptor<>(
-			DialectOverride.OrderBy.class,
-			OverriddenOrderByAnnotation.class,
-			DIALECT_OVERRIDE_ORDER_BYS
-	);
 	OrmAnnotationDescriptor<DialectOverride.ColumnDefaults, OverriddenColumnDefaultsAnnotation> DIALECT_OVERRIDE_COLUMN_DEFAULTS = new OrmAnnotationDescriptor<>(
 			DialectOverride.ColumnDefaults.class,
 			OverriddenColumnDefaultsAnnotation.class

hibernate-core/src/main/java/org/hibernate/boot/models/DialectOverrideAnnotations.java

@@ -470,10 +470,6 @@ public interface HibernateAnnotations {
 			OptimisticLocking.class,
 			OptimisticLockingAnnotation.class
 	);
-	OrmAnnotationDescriptor<OrderBy,OrderByAnnotation> ORDER_BY = new OrmAnnotationDescriptor<>(
-			OrderBy.class,
-			OrderByAnnotation.class
-	);
 	OrmAnnotationDescriptor<ParamDef,ParamDefAnnotation> PARAM_DEF = new OrmAnnotationDescriptor<>(
 			ParamDef.class,
 			ParamDefAnnotation.class