Top Description Fields Constructors Methods
org.hibernate.query

public Class Order<X>

extends Object
Class Inheritance
Annotations
@Incubating
Type Parameters
<X>
The result type of the query to be sorted
Imports
jakarta.persistence.metamodel.SingularAttribute, org.hibernate.Incubating, java.util.Objects
A rule for sorting a query result set.

This is a convenience class which allows query result ordering rules to be passed around the system before being applied to a Query by calling SelectionQuery#setOrder.

A parameter of a HQL query method may be declared with type Order<? super E>, List<Order<? super E>>, or Order<? super E>... (varargs) where E is the entity type returned by the query.

Author
Gavin King
Since
6.3
See Also
SelectionQuery#setOrder(Order), SelectionQuery#setOrder(java.util.List)

Field Summary

Modifier and TypeField and Description
private final SingularAttribute<X, ?>
attribute

private final String
attributeName

private final int
element

private final Class<X>
entityClass

private final NullPrecedence
nullPrecedence

private final SortDirection
order

Constructor Summary

AccessConstructor and Description
private
Order(SortDirection order, NullPrecedence nullPrecedence, SingularAttribute<X, ?> attribute)

private
Order(SortDirection order, NullPrecedence nullPrecedence, Class<X> entityClass, String attributeName)

private
Order(SortDirection order, NullPrecedence nullPrecedence, int element)

Method Summary

Modifier and TypeMethod and Description
public static <T> Order<T>
asc(SingularAttribute<T, ?> attribute)

public static <T> Order<T>
asc(Class<T> entityClass, String attributeName)

public static Order<Object[]>
asc(int element)

public static <T> Order<T>
by(SingularAttribute<T, ?> attribute, SortDirection direction)

public static <T> Order<T>
by(SingularAttribute<T, ?> attribute, SortDirection direction, NullPrecedence nullPrecedence)

public static <T> Order<T>
by(Class<T> entityClass, String attributeName, SortDirection direction)

public static <T> Order<T>
by(Class<T> entityClass, String attributeName, SortDirection direction, NullPrecedence nullPrecedence)

public static Order<Object[]>
by(int element, SortDirection direction)

public static Order<Object[]>
by(int element, SortDirection direction, NullPrecedence nullPrecedence)

public static <T> Order<T>
desc(SingularAttribute<T, ?> attribute)

public static <T> Order<T>
desc(Class<T> entityClass, String attributeName)

public static Order<Object[]>
desc(int element)

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public SingularAttribute<X, ?>
getAttribute()

public String
getAttributeName()

public SortDirection
getDirection()

public int
getElement()

public Class<X>
getEntityClass()

public NullPrecedence
getNullPrecedence()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

attributeback to summary
private final SingularAttribute<X, ?> attribute
attributeNameback to summary
private final String attributeName
elementback to summary
private final int element
entityClassback to summary
private final Class<X> entityClass
nullPrecedenceback to summary
private final NullPrecedence nullPrecedence
orderback to summary
private final SortDirection order

Constructor Detail

Orderback to summary
private Order(SortDirection order, NullPrecedence nullPrecedence, SingularAttribute<X, ?> attribute)
Orderback to summary
private Order(SortDirection order, NullPrecedence nullPrecedence, Class<X> entityClass, String attributeName)
Orderback to summary
private Order(SortDirection order, NullPrecedence nullPrecedence, int element)

Method Detail

ascback to summary
public static <T> Order<T> asc(SingularAttribute<T, ?> attribute)
ascback to summary
public static <T> Order<T> asc(Class<T> entityClass, String attributeName)
ascback to summary
public static Order<Object[]> asc(int element)
byback to summary
public static <T> Order<T> by(SingularAttribute<T, ?> attribute, SortDirection direction)
byback to summary
public static <T> Order<T> by(SingularAttribute<T, ?> attribute, SortDirection direction, NullPrecedence nullPrecedence)
byback to summary
public static <T> Order<T> by(Class<T> entityClass, String attributeName, SortDirection direction)
byback to summary
public static <T> Order<T> by(Class<T> entityClass, String attributeName, SortDirection direction, NullPrecedence nullPrecedence)
byback to summary
public static Order<Object[]> by(int element, SortDirection direction)
byback to summary
public static Order<Object[]> by(int element, SortDirection direction, NullPrecedence nullPrecedence)
descback to summary
public static <T> Order<T> desc(SingularAttribute<T, ?> attribute)
descback to summary
public static <T> Order<T> desc(Class<T> entityClass, String attributeName)
descback to summary
public static Order<Object[]> desc(int element)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAttributeback to summary
public SingularAttribute<X, ?> getAttribute()
getAttributeNameback to summary
public String getAttributeName()
getDirectionback to summary
public SortDirection getDirection()
getElementback to summary
public int getElement()
getEntityClassback to summary
public Class<X> getEntityClass()
getNullPrecedenceback to summary
public NullPrecedence getNullPrecedence()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override