app.myoss.cloud.core.lang.dto

Class Sort

java.lang.Object

app.myoss.cloud.core.lang.dto.Sort

All Implemented Interfaces:

Serializable, Iterable<Order>

public class Sort
extends Object
implements Iterable<Order>, Serializable

Sort option for queries. You have to provide at least a list of properties to sort for that must not include null or empty strings. The direction defaults to DEFAULT_DIRECTION.

Since:

2018年5月9日 下午3:27:19

Author:

Jerry.Chen

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sort.ModelValueDeserializer Sort 反序列化解析器

Field Summary

Fields

Modifier and Type	Field and Description
static Direction	DEFAULT_DIRECTION Default direction

Constructor Summary

Constructors

Constructor and Description
Sort(Direction direction, List<String> properties) Creates a new Sort instance.
Sort(Direction direction, String... properties) Creates a new Sort instance.
Sort(List<Order> orders) Creates a new Sort instance.
Sort(Order... orders) Creates a new Sort instance using the given Orders.
Sort(String... properties) Creates a new Sort instance.

Method Summary

Modifier and Type	Method and Description
Sort	and(Sort sort) Returns a new Sort consisting of the Orders of the current Sort combined with the given ones.
boolean	equals(Object obj)
Order	getOrderFor(String property) Returns the order registered for the given property.
List<Order>	getOrders() Returns all orders
int	hashCode()
Iterator<Order>	iterator()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_DIRECTION

public static final Direction DEFAULT_DIRECTION

Default direction

Constructor Detail

Sort

public Sort(Order... orders)

Creates a new Sort instance using the given Orders.

Parameters:

orders - must not be null.

Sort

public Sort(List<Order> orders)

Creates a new Sort instance.

Parameters:

orders - must not be null or contain null.

Sort

public Sort(String... properties)

Creates a new Sort instance. Order defaults to Direction.ASC.

Parameters:

properties - must not be null or contain null or empty strings

Sort

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

Creates a new Sort instance.

Parameters:

direction - defaults to DEFAULT_DIRECTION (for null cases, too)

properties - must not be null, empty or contain null or empty strings.

Sort

public Sort(Direction direction,
            List<String> properties)

Creates a new Sort instance.

Parameters:

direction - defaults to DEFAULT_DIRECTION (for null cases, too)

properties - must not be null or contain null or empty strings.

Method Detail

and

public Sort and(Sort sort)

Returns a new Sort consisting of the Orders of the current Sort combined with the given ones.

Parameters:

sort - can be null.

Returns:

new Sort

getOrderFor

public Order getOrderFor(String property)

Returns the order registered for the given property.

Parameters:

property - given property

Returns:

the order registered

getOrders

public List<Order> getOrders()

Returns all orders

Returns:

all orders

iterator

public Iterator<Order> iterator()

Specified by:

iterator in interface Iterable<Order>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object