Top Fields Constructors Methods
org.hibernate.query.sqm.tree.select

public Class SqmSortSpecification

extends Object
implements JpaOrder
Class Inheritance
All Implemented Interfaces
org.hibernate.query.criteria.JpaOrder, org.hibernate.query.criteria.JpaCriteriaNode, java.io.Serializable, jakarta.persistence.criteria.Order
Imports
org.hibernate.query.NullPrecedence, .SortDirection, org.hibernate.query.criteria.JpaExpression, .JpaOrder, org.hibernate.query.sqm.tree.SqmCopyContext, org.hibernate.query.sqm.tree.expression.SqmExpression, java.util.Objects
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private NullPrecedence
nullPrecedence

private final SqmExpression<T>
sortExpression

private final SortDirection
sortOrder

Constructor Summary

AccessConstructor and Description
public
SqmSortSpecification(SqmExpression<T> sortExpression, SortDirection sortOrder, NullPrecedence nullPrecedence)

public
SqmSortSpecification(SqmExpression<T> sortExpression)

public
SqmSortSpecification(SqmExpression<T> sortExpression, SortDirection sortOrder)

Method Summary

Modifier and TypeMethod and Description
public void
appendHqlString(StringBuilder sb)

public SqmSortSpecification
copy(SqmCopyContext context)

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 JpaExpression<?>
getExpression()

Implements org.hibernate.query.criteria.JpaOrder.getExpression.

The expression to sort by
public NullPrecedence
getNullPrecedence()

Implements org.hibernate.query.criteria.JpaOrder.getNullPrecedence.

The precedence for nulls for this order element
public SortDirection
getSortDirection()

Implements org.hibernate.query.criteria.JpaOrder.getSortDirection.

The direction, ascending or descending, in which to sort
public SqmExpression<?>
getSortExpression()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isAscending()

Implements jakarta.persistence.criteria.Order.isAscending.

Whether ascending ordering is in effect.
public JpaOrder
nullPrecedence(NullPrecedence nullPrecedence)

Implements org.hibernate.query.criteria.JpaOrder.nullPrecedence.

Set the precedence of nulls for this order element
public JpaOrder
reverse()

Implements org.hibernate.query.criteria.JpaOrder.reverse.

Reverse the sorting direction
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

nullPrecedenceback to summary
private NullPrecedence nullPrecedence
sortExpressionback to summary
private final SqmExpression<T> sortExpression
sortOrderback to summary
private final SortDirection sortOrder

Constructor Detail

SqmSortSpecificationback to summary
public SqmSortSpecification(SqmExpression<T> sortExpression, SortDirection sortOrder, NullPrecedence nullPrecedence)
SqmSortSpecificationback to summary
public SqmSortSpecification(SqmExpression<T> sortExpression)
SqmSortSpecificationback to summary
public SqmSortSpecification(SqmExpression<T> sortExpression, SortDirection sortOrder)

Method Detail

appendHqlStringback to summary
public void appendHqlString(StringBuilder sb)
copyback to summary
public SqmSortSpecification copy(SqmCopyContext context)
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
getExpressionback to summary
public JpaExpression<?> getExpression()

Implements org.hibernate.query.criteria.JpaOrder.getExpression.

Doc from org.hibernate.query.criteria.JpaOrder.getExpression.

The expression to sort by

Returns:JpaExpression<?>

Doc from jakarta.persistence.criteria.Order.getExpression.

expression used for ordering

Annotations
@Override
getNullPrecedenceback to summary
public NullPrecedence getNullPrecedence()

Implements org.hibernate.query.criteria.JpaOrder.getNullPrecedence.

Doc from org.hibernate.query.criteria.JpaOrder.getNullPrecedence.

The precedence for nulls for this order element

Annotations
@Override
getSortDirectionback to summary
public SortDirection getSortDirection()

Implements org.hibernate.query.criteria.JpaOrder.getSortDirection.

Doc from org.hibernate.query.criteria.JpaOrder.getSortDirection.

The direction, ascending or descending, in which to sort

Annotations
@Override
getSortExpressionback to summary
public SqmExpression<?> getSortExpression()
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
isAscendingback to summary
public boolean isAscending()

Implements jakarta.persistence.criteria.Order.isAscending.

Doc from jakarta.persistence.criteria.Order.isAscending.

Whether ascending ordering is in effect.

Returns:boolean

boolean indicating whether ordering is ascending

Annotations
@Override
nullPrecedenceback to summary
public JpaOrder nullPrecedence(NullPrecedence nullPrecedence)

Implements org.hibernate.query.criteria.JpaOrder.nullPrecedence.

Doc from org.hibernate.query.criteria.JpaOrder.nullPrecedence.

Set the precedence of nulls for this order element

Annotations
@Override
reverseback to summary
public JpaOrder reverse()

Implements org.hibernate.query.criteria.JpaOrder.reverse.

Doc from org.hibernate.query.criteria.JpaOrder.reverse.

Reverse the sorting direction

Returns:JpaOrder

Doc from jakarta.persistence.criteria.Order.reverse.

a new Order instance with the reversed ordering

Annotations
@Override