Method Summary

Method Details

• asc

  static <T> Order<T> asc(SingularAttribute<T,?> attribute)

  An order where an entity is sorted by the given attribute, with smaller values first. If the given attribute is of textual type, the ordering is case-sensitive.

• desc

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

  An order where an entity is sorted by the given attribute, with larger values first. If the given attribute is of textual type, the ordering is case-sensitive.

• by

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

  An order where an entity is sorted by the given attribute, in the given direction. If the given attribute is of textual type, the ordering is case-sensitive.

• by

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

  An order where an entity is sorted by the given attribute, in the given direction, with the specified case-sensitivity.

• by

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

  An order where an entity is sorted by the given attribute, in the given direction, with the specified precedence for null values. If the given attribute is of textual type, the ordering is case-sensitive.

• asc

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

  An order where an entity of the given class is sorted by the attribute with the given name, with smaller values first. If the named attribute is of textual type, the ordering is case-sensitive.

• desc

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

  An order where an entity of the given class is sorted by the attribute with the given name, with larger values first. If the named attribute is of textual type, the ordering is case-sensitive.

• by

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

  An order where an entity of the given class is sorted by the attribute with the given name, in the given direction. If the named attribute is of textual type, the ordering is case-sensitive.

• by

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

  An order where an entity of the given class is sorted by the attribute with the given name, in the given direction, with the specified case-sensitivity.

• by

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

  An order where an entity of the given class is sorted by the attribute with the given name, in the given direction. If the named attribute is of textual type, with the specified precedence for null values. If the named attribute is of textual type, the ordering is case-sensitive.

• asc

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

  An order where the result set is sorted by the select item in the given position with smaller values first. If the item is of textual type, the ordering is case-sensitive.

• desc

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

  An order where the result set is sorted by the select item in the given position with larger values first. If the item is of textual type, the ordering is case-sensitive.

• by

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

  An order where the result set is sorted by the select item in the given position, in the given direction. If the item is of textual type, the ordering is case-sensitive.

• by

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

  An order where the result set is sorted by the select item in the given position in the given direction, with the specified case-sensitivity.

• by

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

  An order where the result set is sorted by the select item in the given position in the given direction, with the specified precedence for null values. If the named attribute is of textual type, the ordering is case-sensitive.

• direction

  SortDirection direction()

  The direction,ascending ordescending, in which results are sorted.

  Since:

  7

• nullPrecedence

  Nulls nullPrecedence()

  Theordering of null values.

  Since:

  7

• caseSensitive

  boolean caseSensitive()

  For a lexicographic order based on textual values, whether case is significant.

  Since:

  7

• entityClass

  Class<X> entityClass()

  For an order based on an entity attribute, the entity class which declares theattribute.

  Returns:

  the Java class which declares the attribute, ornull if this order is not based on an attribute

  Since:

  7

• attributeName

  String attributeName()

  For an order based on an entity attribute, the name of theattribute.

  Returns:

  the name of the attribute, ornull if this order is not based on an attribute

  Since:

  7

• attribute

  SingularAttribute<X,?> attribute()

  For an order based on an entity attribute, the metamodel object representing the attribute.

  Returns:

  the attribute, ornull if this order is not based on an attribute, or if only the name of the attribute was specified

  Since:

  7

• element

  int element()

  For an order based on an indexed element of the select clause, the index of the element.

  Returns:

  the index, or1 is this order is based on an entity attribute

  Since:

  7

• reverse

  Order<X> reverse()

  Returns:

  this order, but with the sorting direction reversed.

  Since:

  6.5

• ignoringCase

  Order<X> ignoringCase()

  Returns:

  this order, but without case-sensitivity.

  Since:

  6.5

• withNullsFirst

  Order<X> withNullsFirst()

  Returns:

  this order, but with nulls sorted first.

  Since:

  6.5

• withNullsLast

  Order<X> withNullsLast()

  Returns:

  this order, but with nulls sorted last.

  Since:

  6.5

• reversedIf

  default Order<X> reversedIf(boolean reverse)

  An order based on this order, possibly reversed.

  Parameters:

  reverse -true if the returned order should bereversed

  Returns:

  this order, but reversed if the argument istrue

  Since:

  7.0

  API Note:

  This is a convenience for use with Jakarta Data

• ignoringCaseIf

  default Order<X> ignoringCaseIf(boolean ignoreCase)

  An order based on this order, possibly without case-sensitivity.

  Parameters:

  ignoreCase -true if this order shouldignore case

  Returns:

  this order, but ignoring case if the argument istrue

  Since:

  7.0

  API Note:

  This is a convenience for use with Jakarta Data

• reverse

  static <T> List<Order<? super T>> reverse(List<Order<? super T>> ordering)

  Reverse the direction of the given ordering list

  Parameters:

  ordering - a list ofOrder items

  Returns:

  a new list, with eachOrder reversed

  Since:

  6.5

  See Also:

  • reverse()

• getDirection

  @Deprecated(since="7",forRemoval=true)default SortDirection getDirection()

  Deprecated, for removal: This API element is subject to removal in a future version.

• getNullPrecedence

  @Deprecated(since="7",forRemoval=true)default Nulls getNullPrecedence()

  Deprecated, for removal: This API element is subject to removal in a future version.

• isCaseInsensitive

  @Deprecated(since="7",forRemoval=true)default boolean isCaseInsensitive()

  Deprecated, for removal: This API element is subject to removal in a future version.

• getAttribute

  @Deprecated(since="7",forRemoval=true)default SingularAttribute<X,?> getAttribute()

  Deprecated, for removal: This API element is subject to removal in a future version.

• getEntityClass

  @Deprecated(since="7",forRemoval=true)default Class<X> getEntityClass()

  Deprecated, for removal: This API element is subject to removal in a future version.

• getAttributeName

  @Deprecated(since="7",forRemoval=true)default String getAttributeName()

  Deprecated, for removal: This API element is subject to removal in a future version.

• getElement

  @Deprecated(since="7",forRemoval=true)default int getElement()

  Deprecated, for removal: This API element is subject to removal in a future version.