Module is.codion.framework.domain

Package is.codion.framework.domain.entity

Interface OrderBy

public interface OrderBy

Specifies an order by clause.

See Also:

• ascending(Column[])
• descending(Column[])
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OrderBy.Builder	Builds a OrderBy instance.
static enum	OrderBy.NullOrder	Specifies how to handle null values during order by.
static interface	OrderBy.OrderByColumn	Specifies an order by column and whether it's ascending or descending

Method Summary

Modifier and Type	Method	Description
static OrderBy	ascending(Column<?>... columns)
static OrderBy.Builder	builder()	Creates a OrderBy.Builder instance.
static OrderBy	descending(Column<?>... columns)
List<OrderBy.OrderByColumn>	orderByColumns()

Method Details

orderByColumns

List<OrderBy.OrderByColumn> orderByColumns()

Returns:

the order by columns comprising this order by clause

builder

static OrderBy.Builder builder()

Creates a OrderBy.Builder instance.

Returns:

a OrderBy.Builder instance

ascending

static OrderBy ascending(Column<?>... columns)

Parameters:

columns - the columns to order by ascending

Returns:

a new ascending OrderBy instance based on the given columns

descending

static OrderBy descending(Column<?>... columns)

Parameters:

columns - the columns to order by descending

Returns:

a new descending OrderBy instance based on the given columns