Sort (Spring Data Core 2.1.16.RELEASE API)

java.lang.Object
- org.springframework.data.domain.Sort

All Implemented Interfaces:

Serializable, Iterable<Sort.Order>, Supplier<Stream<Sort.Order>>, Streamable<Sort.Order>

Direct Known Subclasses:

QSort, RevisionSort
```
public class Sort
extends Object
implements Streamable<Sort.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.

Author:

Oliver Gierke, Thomas Darimont, Mark Paluch

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Sort.Direction` Enumeration for sort directions.
`static class`	`Sort.NullHandling` Enumeration for null handling hints that can be used in `Sort.Order` expressions.
`static class`	`Sort.Order` PropertyPath implements the pairing of an `Sort.Direction` and a property.

Field Summary

Fields
Modifier and Type Field and Description

static Sort.Direction DEFAULT_DIRECTION

Fields
Modifier and Type	Field and Description
`static Sort.Direction`	`DEFAULT_DIRECTION`

Constructor Summary

Constructors
Constructor and Description
`Sort(List<Sort.Order> orders)` Deprecated. see `by(List)`
`Sort(Sort.Direction direction, List<String> properties)` Creates a new `Sort` instance.
`Sort(Sort.Direction direction, String... properties)` Creates a new `Sort` instance.
`Sort(Sort.Order... orders)` Deprecated.
`Sort(String... properties)` Deprecated. use `by(String...)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Sort`	`and(Sort sort)` Returns a new `Sort` consisting of the `Sort.Order`s of the current `Sort` combined with the given ones.
`Sort`	`ascending()` Returns a new `Sort` with the current setup but ascending order direction.
`static Sort`	`by(List<Sort.Order> orders)` Creates a new `Sort` for the given `Sort.Order`s.
`static Sort`	`by(Sort.Direction direction, String... properties)` Creates a new `Sort` for the given `Sort.Order`s.
`static Sort`	`by(Sort.Order... orders)` Creates a new `Sort` for the given `Sort.Order`s.
`static Sort`	`by(String... properties)` Creates a new `Sort` for the given properties.
`Sort`	`descending()` Returns a new `Sort` with the current setup but descending order direction.
`boolean`	`equals(Object obj)`
`Sort.Order`	`getOrderFor(String property)` Returns the order registered for the given property.
`int`	`hashCode()`
`boolean`	`isSorted()`
`boolean`	`isUnsorted()`
`Iterator<Sort.Order>`	`iterator()`
`String`	`toString()`
`static Sort`	`unsorted()` Returns a `Sort` instances representing no sorting setup at all.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.util.Streamable
and, empty, filter, flatMap, get, isEmpty, map, of, of, of, stream

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - DEFAULT_DIRECTION
```
public static final Sort.Direction DEFAULT_DIRECTION
```
- Constructor Detail
  - Sort
```
@Deprecated
public Sort(Sort.Order... orders)
```
    Deprecated.
    
    Creates a new Sort instance using the given Sort.Orders.
    
    Parameters:
    
    orders - must not be null.
  - Sort
```
@Deprecated
public Sort(List<Sort.Order> orders)
```
    Deprecated. see by(List)
    
    Creates a new Sort instance.
    
    Parameters:
    
    orders - must not be null or contain null.
  - Sort
```
@Deprecated
public Sort(String... properties)
```
    Deprecated. use by(String...)
    
    Creates a new Sort instance. Order defaults to .
    
    Parameters:
    
    properties - must not be null or contain null or empty strings
  - Sort
```
public Sort(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(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
  - by
```
public static Sort by(String... properties)
```
    Creates a new Sort for the given properties.
    
    Parameters:
    
    properties - must not be null.
    
    Returns:
  - by
```
public static Sort by(List<Sort.Order> orders)
```
    Creates a new Sort for the given Sort.Orders.
    
    Parameters:
    
    orders - must not be null.
    
    Returns:
  - by
```
public static Sort by(Sort.Order... orders)
```
    Creates a new Sort for the given Sort.Orders.
    
    Parameters:
    
    orders - must not be null.
    
    Returns:
  - by
```
public static Sort by(Sort.Direction direction,
                      String... properties)
```
    Creates a new Sort for the given Sort.Orders.
    
    Parameters:
    
    direction - must not be null.
    
    properties - must not be null.
    
    Returns:
  - unsorted
```
public static Sort unsorted()
```
    Returns a Sort instances representing no sorting setup at all.
    
    Returns:
  - descending
```
public Sort descending()
```
    Returns a new Sort with the current setup but descending order direction.
    
    Returns:
  - ascending
```
public Sort ascending()
```
    Returns a new Sort with the current setup but ascending order direction.
    
    Returns:
  - isSorted
```
public boolean isSorted()
```
  - isUnsorted
```
public boolean isUnsorted()
```
  - and
```
public Sort and(Sort sort)
```
    Returns a new Sort consisting of the Sort.Orders of the current Sort combined with the given ones.
    
    Parameters:
    
    sort - must not be null.
    
    Returns:
  - getOrderFor
```
@Nullable
public Sort.Order getOrderFor(String property)
```
    Returns the order registered for the given property.
    
    Parameters:
    
    property -
    
    Returns:
  - iterator
```
public Iterator<Sort.Order> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Sort.Order>
  - equals
```
public boolean equals(@Nullable
                      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

Class Sort

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.data.util.Streamable

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_DIRECTION

Constructor Detail

Sort

Sort

Sort

Sort

Sort

Method Detail

by

by

by

by

unsorted

descending

ascending

isSorted

isUnsorted

and

getOrderFor

iterator

equals

hashCode

toString