Package io.jmix.core

Class Sort

java.lang.Object

io.jmix.core.Sort

All Implemented Interfaces:

Serializable

public class Sort
extends Object
implements Serializable

Defines sorting of queries.

Based on the Sort class from Spring Data project.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Sort.Direction	Sort direction.
static class	Sort.Order	Sort order defines a property and corresponding Sort.Direction.

Field Summary

Fields

Modifier and Type	Field	Description
static final Sort	UNSORTED	Undefined sort order.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Sort(Sort.Direction direction, List<String> properties)
protected	Sort(List<Sort.Order> orders)

Method Summary

Modifier and Type	Method	Description
static Sort	by(Sort.Direction direction, String... properties)	Creates new Sort for the given properties with the given direction.
static Sort	by(Sort.Order... orders)	Creates new Sort for the given orders.
static Sort	by(String... properties)	Creates new Sort for the given properties with ASC direction.
static Sort	by(List<Sort.Order> orders)	Creates new Sort for the given list of orders.
List<Sort.Order>	getOrders()	Returns unmodifiable list of orders.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

UNSORTED

public static final Sort UNSORTED

Undefined sort order.

Constructor Details

Sort

protected Sort(List<Sort.Order> orders)

Sort

protected Sort(Sort.Direction direction,
 List<String> properties)

Method Details

by

public static Sort by(List<Sort.Order> orders)

Creates new Sort for the given list of orders.

by

public static Sort by(Sort.Order... orders)

Creates new Sort for the given orders.

by

public static Sort by(String... properties)

Creates new Sort for the given properties with ASC direction.

by

public static Sort by(Sort.Direction direction,
 String... properties)

Creates new Sort for the given properties with the given direction.

getOrders

public List<Sort.Order> getOrders()

Returns unmodifiable list of orders.

toString

public String toString()

Overrides:

toString in class Object