com.mongodb.client.model

Class Sorts

java.lang.Object

com.mongodb.client.model.Sorts

public final class Sorts
extends Object

A factory for sort specifications. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.find().sort(orderBy(ascending("x", "y"), descending("z")))
 

Since:

3.0

MongoDB documentation

Sort

Method Summary

Modifier and Type	Method and Description
static Bson	ascending(List<String> fieldNames) Create a sort specification for an ascending sort on the given fields.
static Bson	ascending(String... fieldNames) Create a sort specification for an ascending sort on the given fields.
static Bson	descending(List<String> fieldNames) Create a sort specification for an ascending sort on the given fields.
static Bson	descending(String... fieldNames) Create a sort specification for an ascending sort on the given fields.
static Bson	metaTextScore(String fieldName) Create a sort specification for the text score meta projection on the given field.
static Bson	orderBy(Bson... sorts) Combine multiple sort specifications.
static Bson	orderBy(List<? extends Bson> sorts) Combine multiple sort specifications.

Methods inherited from class java.lang.Object

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

Method Detail

ascending

public static Bson ascending(String... fieldNames)

Create a sort specification for an ascending sort on the given fields.

Parameters:

fieldNames - the field names, which must contain at least one

Returns:

the sort specification

MongoDB documentation

Sort

ascending

public static Bson ascending(List<String> fieldNames)

Create a sort specification for an ascending sort on the given fields.

Parameters:

fieldNames - the field names, which must contain at least one

Returns:

the sort specification

MongoDB documentation

Sort

descending

public static Bson descending(String... fieldNames)

Create a sort specification for an ascending sort on the given fields.

Parameters:

fieldNames - the field names, which must contain at least one

Returns:

the sort specification

MongoDB documentation

Sort

descending

public static Bson descending(List<String> fieldNames)

Create a sort specification for an ascending sort on the given fields.

Parameters:

fieldNames - the field names, which must contain at least one

Returns:

the sort specification

MongoDB documentation

Sort

metaTextScore

public static Bson metaTextScore(String fieldName)

Create a sort specification for the text score meta projection on the given field.

Parameters:

fieldName - the field name

Returns:

the sort specification

MongoDB documentation

textScore

orderBy

public static Bson orderBy(Bson... sorts)

Combine multiple sort specifications. If any field names are repeated, the last one takes precedence.

Parameters:

sorts - the sort specifications

Returns:

the combined sort specification

orderBy

public static Bson orderBy(List<? extends Bson> sorts)

Combine multiple sort specifications. If any field names are repeated, the last one takes precedence.

Parameters:

sorts - the sort specifications

Returns:

the combined sort specification