Package dev.morphia.query
Class Sort
- java.lang.Object
-
- dev.morphia.query.Sort
-
- Direct Known Subclasses:
Sort
public class Sort extends java.lang.ObjectUsed for sorting query results or defining a sort stage in an aggregation pipeline- Since:
- 1.3
- MongoDB documentation
- reference/operator/aggregation/sort/ $sort
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedSort(java.lang.String field, int order)Creates a sort on a field with a direction.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Sortascending(java.lang.String field)Creates an ascending sort on a fieldstatic Sortdescending(java.lang.String field)Creates a descending sort on a fieldjava.lang.StringgetField()intgetOrder()Returns the sort order.static SortnaturalAscending()Creates an ascending sort on a fieldstatic SortnaturalDescending()Creates a descending natural sort on a field
-
-
-
Method Detail
-
ascending
public static Sort ascending(java.lang.String field)
Creates an ascending sort on a field- Parameters:
field- the field- Returns:
- the Sort instance
-
descending
public static Sort descending(java.lang.String field)
Creates a descending sort on a field- Parameters:
field- the field- Returns:
- the Sort instance
-
naturalAscending
public static Sort naturalAscending()
Creates an ascending sort on a field- Returns:
- the Sort instance
-
naturalDescending
public static Sort naturalDescending()
Creates a descending natural sort on a field- Returns:
- the Sort instance
-
getOrder
public int getOrder()
Returns the sort order.- 1 for ascending order.
- -1 for descending order.
- Returns:
- the sort order
-
getField
public java.lang.String getField()
- Returns:
- the sort field
-
-