Class OrderBy

ebean-api/src/main/java/io/ebean/OrderBy.java:17–502

Represents an Order By for a Query. Is an ordered list of OrderBy.Property objects each specifying a property and whether it is ascending or descending order. Typically, you will not construct an OrderBy yourself but use one that exists on the Query object.

 * on the Query object.
 */
public class OrderBy<T> implements Serializable {

  private static final long serialVersionUID = 9157089257745730539L;

  private transient Query<T> query;

  private final List<Property> list;

  /**
   * Create an OrderBy parsing the given order by clause.
   * <p>
   * The order by clause follows SQL order by clause with comma's between each
   * property and optionally "asc" or "desc" to represent ascending or
   * descending order respectively.
   */
  public static <P> OrderBy<P> of(String orderByClause) {
    return new OrderBy<>(orderByClause);
  }

  /**
   * @deprecated This method will be removed from public API.
   * <p>
   * Create an empty OrderBy with no associated query.
   */
  @Deprecated(forRemoval = true)
  public OrderBy() {
    this.list = new ArrayList<>(3);
  }

  private OrderBy(List<Property> list) {
    this.list = list;
  }

  /**
   * @deprecated migrate to {@link OrderBy#of(String)}.
   */
  @Deprecated(forRemoval = true)
  public OrderBy(String orderByClause) {
    this(null, orderByClause);
  }

  /**
   * @deprecated This method will be removed from public API.
   */
  @Deprecated(forRemoval = true)
  public OrderBy(Query<T> query, String orderByClause) {
    this.query = query;
    this.list = new ArrayList<>(3);
    parse(orderByClause);
  }

  /**
   * Reverse the ascending/descending order on all the properties.
   */
  public void reverse() {
    for (Property aList : list) {
      aList.reverse();
    }