Package com.blazebit.persistence

Interface OrderByBuilder<T extends OrderByBuilder<T>>

Type Parameters:

T - The concrete builder type

All Known Subinterfaces:

BaseCriteriaBuilder<T,X>, BaseCTECriteriaBuilder<X>, BaseFinalSetOperationBuilder<T,X>, BaseInsertCriteriaBuilder<T,X>, BaseOngoingFinalSetOperationBuilder<T,X>, BaseQueryBuilder<T,X>, BaseSubqueryBuilder<X>, CriteriaBuilder<T>, FinalSetOperationCriteriaBuilder<T>, FinalSetOperationCTECriteriaBuilder<T>, FinalSetOperationSubqueryBuilder<T>, FullQueryBuilder<T,X>, FullSelectCTECriteriaBuilder<X>, InsertCriteriaBuilder<T>, LeafOngoingSetOperationCriteriaBuilder<X>, LeafOngoingSetOperationCTECriteriaBuilder<X>, LeafOngoingSetOperationSubqueryBuilder<X>, OngoingFinalSetOperationCriteriaBuilder<T>, OngoingFinalSetOperationCTECriteriaBuilder<T>, OngoingFinalSetOperationSubqueryBuilder<T>, OngoingSetOperationCriteriaBuilder<T,Y>, OngoingSetOperationCTECriteriaBuilder<T,Y>, OngoingSetOperationSubqueryBuilder<T,Y>, PaginatedCriteriaBuilder<T>, QueryBuilder<T,X>, ReturningInsertCriteriaBuilder<T,X>, SelectBaseCTECriteriaBuilder<X>, SelectCTECriteriaBuilder<X>, SelectRecursiveCTECriteriaBuilder<X>, StartOngoingSetOperationCriteriaBuilder<X,Y>, StartOngoingSetOperationCTECriteriaBuilder<X,Y>, StartOngoingSetOperationSubqueryBuilder<X,Y>, SubqueryBuilder<T>

public interface OrderByBuilder<T extends OrderByBuilder<T>>

An interface for builders that support sorting. This is related to the fact, that a query builder supports order by clauses.

Since:

1.0.0

Author:

Christian Beikov

Method Summary

Modifier and Type	Method	Description
T	orderBy(String expression, boolean ascending, boolean nullFirst)	Adds an order by clause with the given expression to the query.
T	orderByAsc(String expression)	Like orderByAsc(java.lang.String, boolean) but with nullFirst set to false.
T	orderByAsc(String expression, boolean nullFirst)	Like orderBy(java.lang.String, boolean, boolean) but with ascending set to true.
T	orderByDesc(String expression)	Like orderByDesc(java.lang.String, boolean) but with nullFirst set to false.
T	orderByDesc(String expression, boolean nullFirst)	Like orderBy(java.lang.String, boolean, boolean) but with ascending set to false.

Method Detail

orderBy

T orderBy(String expression,
          boolean ascending,
          boolean nullFirst)

Adds an order by clause with the given expression to the query.

Parameters:

expression - The expression for the order by clause

ascending - Wether the order should be ascending or descending.

nullFirst - Wether null elements should be ordered first or not.

Returns:

The query builder for chaining calls

orderByAsc

T orderByAsc(String expression)

Like orderByAsc(java.lang.String, boolean) but with nullFirst set to false.

Parameters:

expression - The expression for the order by clause

Returns:

The query builder for chaining calls

orderByAsc

T orderByAsc(String expression,
             boolean nullFirst)

Like orderBy(java.lang.String, boolean, boolean) but with ascending set to true.

Parameters:

expression - The expression for the order by clause

nullFirst - Wether null elements should be ordered first or not.

Returns:

The query builder for chaining calls

orderByDesc

T orderByDesc(String expression)

Like orderByDesc(java.lang.String, boolean) but with nullFirst set to false.

Parameters:

expression - The expression for the order by clause

Returns:

The query builder for chaining calls

orderByDesc

T orderByDesc(String expression,
              boolean nullFirst)

Like orderBy(java.lang.String, boolean, boolean) but with ascending set to false.

Parameters:

expression - The expression for the order by clause

nullFirst - Wether null elements should be ordered first or not.

Returns:

The query builder for chaining calls