reimplement Order using record classes

Author: gavinking

hibernate-core/src/main/java/org/hibernate/query/AttributeOrder.java

@@ -0,0 +1,77 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.query;
+
+import jakarta.persistence.criteria.Nulls;
+import jakarta.persistence.metamodel.SingularAttribute;
+
+/**
+ * An {@link Order} based on an attribute of an entity.
+ *
+ * @param <X> The entity type
+ *
+ * @author Gavin King
+ */
+record AttributeOrder<X>
+		(SortDirection direction, Nulls nullPrecedence, SingularAttribute<X, ?> attribute, boolean caseSensitive)
+		implements Order<X> {
+
+	AttributeOrder(SortDirection order, Nulls nullPrecedence, SingularAttribute<X, ?> attribute) {
+		this( order, nullPrecedence, attribute, true );
+	}
+
+	private AttributeOrder(AttributeOrder<X> that, Nulls nullPrecedence) {
+		this( that.direction, nullPrecedence, that.attribute, that.caseSensitive );
+	}
+
+	private AttributeOrder(AttributeOrder<X> that, SortDirection direction) {
+		this( direction, that.nullPrecedence, that.attribute, that.caseSensitive );
+	}
+
+	private AttributeOrder(AttributeOrder<X> that, boolean caseSensitive) {
+		this( that.direction, that.nullPrecedence, that.attribute, caseSensitive );
+	}
+
+	@Override
+	public Class<X> entityClass() {
+		return attribute.getDeclaringType().getJavaType();
+	}
+
+	@Override
+	public int element() {
+		return 1;
+	}
+
+	@Override
+	public String attributeName() {
+		return attribute.getName();
+	}
+
+	@Override
+	public Order<X> ignoringCase() {
+		return new AttributeOrder<>( this, true );
+	}
+
+	@Override
+	public Order<X> reverse() {
+		return new AttributeOrder<>( this, direction.reverse() );
+	}
+
+	@Override
+	public Order<X> withNullsFirst() {
+		return new AttributeOrder<>( this, Nulls.FIRST );
+	}
+
+	@Override
+	public Order<X> withNullsLast() {
+		return new AttributeOrder<>( this, Nulls.LAST );
+	}
+
+	@Override
+	public String toString() {
+		return attribute.getName() + " " + direction;
+	}
+
+}

hibernate-core/src/main/java/org/hibernate/query/ElementOrder.java

@@ -0,0 +1,65 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.query;
+
+import jakarta.persistence.criteria.Nulls;
+import jakarta.persistence.metamodel.SingularAttribute;
+
+/**
+ * An {@link Order} based on an indexed element of a select clause.
+ *
+ * @param <X> The query result type
+ *
+ * @author Gavin King
+ */
+record ElementOrder<X>
+		(SortDirection direction, Nulls nullPrecedence, int element, boolean caseSensitive)
+		implements Order<X> {
+
+	ElementOrder(SortDirection order, Nulls nullPrecedence, int element) {
+		this( order, nullPrecedence, element, true );
+	}
+
+	@Override
+	public Class<X> entityClass() {
+		return null;
+	}
+
+	@Override
+	public String attributeName() {
+		return null;
+	}
+
+	@Override
+	public SingularAttribute<X, ?> attribute() {
+		return null;
+	}
+
+	@Override
+	public Order<X> ignoringCase() {
+		return new ElementOrder<>( direction, nullPrecedence, element, false );
+	}
+
+	@Override
+	public Order<X> reverse() {
+		return new ElementOrder<>( direction.reverse(), nullPrecedence, element, caseSensitive );
+	}
+
+	@Override
+	public Order<X> withNullsFirst() {
+		return new ElementOrder<>( direction, Nulls.FIRST, element );
+	}
+
+	@Override
+	public Order<X> withNullsLast() {
+		return new ElementOrder<>( direction, Nulls.LAST, element );
+	}
+
+	@Override
+	public String toString() {
+		return element + " " + direction;
+	}
+
+}

hibernate-core/src/main/java/org/hibernate/query/NamedAttributeOrder.java

@@ -0,0 +1,72 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.query;
+
+import jakarta.persistence.criteria.Nulls;
+import jakarta.persistence.metamodel.SingularAttribute;
+
+/**
+ * An {@link Order} based on the name of an attribute of an entity.
+ *
+ * @param <X> The entity type
+ *
+ * @author Gavin King
+ */
+record NamedAttributeOrder<X>
+		(SortDirection direction, Nulls nullPrecedence, Class<X> entityClass, String attributeName, boolean caseSensitive)
+		implements Order<X> {
+
+	NamedAttributeOrder(SortDirection order, Nulls nullPrecedence, Class<X> entityClass, String attributeName) {
+		this( order, nullPrecedence, entityClass, attributeName, true );
+	}
+
+	private NamedAttributeOrder(NamedAttributeOrder<X> that, Nulls nullPrecedence) {
+		this( that.direction, nullPrecedence, that.entityClass, that.attributeName, that.caseSensitive );
+	}
+
+	private NamedAttributeOrder(NamedAttributeOrder<X> that, SortDirection direction) {
+		this( direction, that.nullPrecedence, that.entityClass, that.attributeName, that.caseSensitive );
+	}
+
+	private NamedAttributeOrder(NamedAttributeOrder<X> that, boolean caseSensitive) {
+		this( that.direction, that.nullPrecedence, that.entityClass, that.attributeName, caseSensitive );
+	}
+
+	@Override
+	public int element() {
+		return 1;
+	}
+
+	@Override
+	public SingularAttribute<X, ?> attribute() {
+		return null;
+	}
+
+	@Override
+	public Order<X> ignoringCase() {
+		return new NamedAttributeOrder<>( this, false );
+	}
+
+	@Override
+	public Order<X> reverse() {
+		return new NamedAttributeOrder<>( this, direction.reverse() );
+	}
+
+	@Override
+	public Order<X> withNullsFirst() {
+		return new NamedAttributeOrder<>( this, Nulls.FIRST );
+	}
+
+	@Override
+	public Order<X> withNullsLast() {
+		return new NamedAttributeOrder<>( this, Nulls.LAST );
+	}
+
+	@Override
+	public String toString() {
+		return attributeName + " " + direction;
+	}
+
+}