Ordering

@Beta
public final class Ordering

---

Represents an ordering criterion for sorting documents in a Firestore pipeline.

You create Ordering instances using the ascending and descending helper methods.

Summary

Nested types
public static class Ordering.Companion
public enum Ordering.Direction extends Enum

Public fields
final @NonNull Ordering.Direction	dir
final @NonNull Expression	expr

Public methods
static final @NonNull Ordering	ascending(@NonNull Expression expr) Create an Ordering that sorts documents in ascending order based on value of expr.
static final @NonNull Ordering	ascending(@NonNull String fieldName) Creates an Ordering that sorts documents in ascending order based on field.
static final @NonNull Ordering	descending(@NonNull Expression expr) Create an Ordering that sorts documents in descending order based on value of expr.
static final @NonNull Ordering	descending(@NonNull String fieldName) Creates an Ordering that sorts documents in descending order based on field.
boolean	equals(Object other)
int	hashCode()

Public fields

dir

public final @NonNull Ordering.Direction dir

expr

public final @NonNull Expression expr

Public methods

ascending

public static final @NonNull Ordering ascending(@NonNull Expression expr)

Create an Ordering that sorts documents in ascending order based on value of expr.

Parameters
@NonNull Expression expr	The order is based on the evaluation of the Expression.

Returns
@NonNull Ordering	A new Ordering object with ascending sort by expr.

ascending

public static final @NonNull Ordering ascending(@NonNull String fieldName)

Creates an Ordering that sorts documents in ascending order based on field.

Parameters
@NonNull String fieldName	The name of field to sort documents.

Returns
@NonNull Ordering	A new Ordering object with ascending sort by field.

descending

public static final @NonNull Ordering descending(@NonNull Expression expr)

Create an Ordering that sorts documents in descending order based on value of expr.

Parameters
@NonNull Expression expr	The order is based on the evaluation of the Expression.

Returns
@NonNull Ordering	A new Ordering object with descending sort by expr.

descending

public static final @NonNull Ordering descending(@NonNull String fieldName)

Creates an Ordering that sorts documents in descending order based on field.

Parameters
@NonNull String fieldName	The name of field to sort documents.

Returns
@NonNull Ordering	A new Ordering object with descending sort by field.

equals

public boolean equals(Object other)

hashCode

public int hashCode()