Annotation Type OrderBy


  • @Target({METHOD,FIELD})
    @Retention(RUNTIME)
    public @interface OrderBy
    Order a collection using an expression written in native SQL.

    The order is applied by the database when the collection is fetched, but is not maintained by operations that mutate the collection in memory. If the collection is a Set or Map, the order is maintained using a LinkedHashSet or LinkedHashMap.

    • Use OrderBy to order using an expression written in HQL.
    • Use SortComparator to sort the collection in memory using a Comparator.
    • Use SortNatural to sort the collection in its natural order.
    • Use OrderColumn to maintain the order of a List with a dedicated index column.

    It is illegal to use both OrderBy and OrderBy.

    See Also:
    OrderBy, SortComparator, SortNatural
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String clause
      The native SQL expression used to sort the collection elements.
    • Element Detail

      • clause

        String clause
        The native SQL expression used to sort the collection elements.