Package com.blazebit.persistence.deltaspike.data

Class Sort

java.lang.Object

com.blazebit.persistence.deltaspike.data.Sort

All Implemented Interfaces:

Serializable, Iterable<Sort.Order>

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

Immutable container for sorting information, heavily inspired by Spring Data's Sort.

Since:

1.2.0

Author:

Christian Beikov

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Sort.Direction	Sort directions.
static enum	Sort.NullHandling	Enumeration for null handling of an Sort.Order.
static class	Sort.Order	PropertyPath implements the pairing of an Sort.Direction and a property.

Constructor Summary

Constructors

Constructor	Description
Sort(Sort.Direction direction, String... paths)	Creates a new Sort with the given paths the given direction.
Sort(Sort.Direction direction, List<String> paths)	Creates a new Sort with the given paths and given direction.
Sort(Sort.Order... orders)	Creates a new Sort with the given Sort.Orders.
Sort(String... paths)	Creates a new Sort with the given paths and the Sort.Direction.ASC.
Sort(Collection<Sort.Order> orders)	Creates a new Sort with the given Sort.Orders.

Method Summary

Modifier and Type	Method	Description
Sort	and(Sort sort)	Returns a new Sort representing the union of the Sort.Orders of this and the given Sort.
boolean	equals(Object obj)
Sort.Order	getOrderFor(String path)	Returns the order for the given path or null if there is none.
int	hashCode()
Iterator<Sort.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

Constructor Details

Sort

public Sort(Sort.Order... orders)

Creates a new Sort with the given Sort.Orders.

Parameters:

orders - The orders to use for sorting

Sort

public Sort(Collection<Sort.Order> orders)

Creates a new Sort with the given Sort.Orders.

Parameters:

orders - The orders to use for sorting

Sort

public Sort(String... paths)

Creates a new Sort with the given paths and the Sort.Direction.ASC.

Parameters:

paths - The paths by which to sort

Sort

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

Creates a new Sort with the given paths the given direction.

Parameters:

direction - The direction to use for sorting

paths - The paths by which to sort

Sort

public Sort(Sort.Direction direction,
 List<String> paths)

Creates a new Sort with the given paths and given direction.

Parameters:

direction - The direction to use for sorting

paths - The paths by which to sort

Method Details

and

public Sort and(Sort sort)

Returns a new Sort representing the union of the Sort.Orders of this and the given Sort.

Parameters:

sort - The other sort, may be null

Returns:

A new Sort with the union of this and the Sort.Orders of the given Sort

getOrderFor

public Sort.Order getOrderFor(String path)

Returns the order for the given path or null if there is none.

Parameters:

path - The path for which to get the Sort.Order

Returns:

The Sort.Order for the given path or null it there is none

iterator

public Iterator<Sort.Order> iterator()

Specified by:

iterator in interface Iterable<Sort.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