AggregateField

public abstract class AggregateField

Known direct subclasses
AggregateField.AverageAggregateField

Represents an "average" aggregation that can be performed by Firestore.
AggregateField.CountAggregateField

Represents a "count" aggregation that can be performed by Firestore.
AggregateField.SumAggregateField

Represents a "sum" aggregation that can be performed by Firestore.

Represents an aggregation that can be performed by Firestore.

Summary

Nested types

Represents an "average" aggregation that can be performed by Firestore.

Represents a "count" aggregation that can be performed by Firestore.

Represents a "sum" aggregation that can be performed by Firestore.

Public fields
final @NonNull String
final @NonNull String

Public methods
static @NonNull AggregateField.AverageAggregateField

Create an AverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.
static @NonNull AggregateField.AverageAggregateField

Create an AverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.
static @NonNull AggregateField.CountAggregateField

Create a CountAggregateField object that can be used to compute the count of documents in the result set of a query.
boolean
equals(Object other)

Returns true if the given object is equal to this object.
int

Calculates and returns the hash code for this object.
static @NonNull AggregateField.SumAggregateField
sum(@NonNull String field)

Create a SumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.
static @NonNull AggregateField.SumAggregateField
sum(@NonNull FieldPath fieldPath)

Create a SumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

Public fields

alias

public final @NonNull String alias

operator

public final @NonNull String operator

Public methods

average

public static @NonNull AggregateField.AverageAggregateField average(@NonNull String field)

Create an AverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

The result of an average operation will always be a double or NaN.

  • Averaging over zero documents or fields will result in a double value representing NaN.
  • Averaging over NaN will result in a double value representing NaN.
Parameters
@NonNull String field

Specifies the field to average across the result set.
Returns
@NonNull AggregateField.AverageAggregateField

The `AverageAggregateField` object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

average

public static @NonNull AggregateField.AverageAggregateField average(@NonNull FieldPath fieldPath)

Create an AverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

The result of an average operation will always be a double or NaN.

  • Averaging over zero documents or fields will result in a double value representing NaN.
  • Averaging over NaN will result in a double value representing NaN.
Parameters
@NonNull FieldPath fieldPath

Specifies the field to average across the result set.
Returns
@NonNull AggregateField.AverageAggregateField

The `AverageAggregateField` object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

count

public static @NonNull AggregateField.CountAggregateField count()

Create a CountAggregateField object that can be used to compute the count of documents in the result set of a query.

The result of a count operation will always be a 64-bit integer value.

Returns
@NonNull AggregateField.CountAggregateField

The `CountAggregateField` object that can be used to compute the count of documents in the result set of a query.

equals

public boolean equals(Object other)

Returns true if the given object is equal to this object. Two `AggregateField` objects are considered equal if they have the same operator and operate on the same field.

hashCode

public int hashCode()

Calculates and returns the hash code for this object.

sum

public static @NonNull AggregateField.SumAggregateField sum(@NonNull String field)

Create a SumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

The result of a sum operation will always be a 64-bit integer value, a double, or NaN.

  • Summing over zero documents or fields will result in 0L.
  • Summing over NaN will result in a double value representing NaN.
  • A sum that overflows the maximum representable 64-bit integer value will result in a double return value. This may result in lost precision of the result.
  • A sum that overflows the maximum representable double value will result in a double return value representing infinity.
Parameters
@NonNull String field

Specifies the field to sum across the result set.
Returns
@NonNull AggregateField.SumAggregateField

The `SumAggregateField` object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

sum

public static @NonNull AggregateField.SumAggregateField sum(@NonNull FieldPath fieldPath)

Create a SumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

The result of a sum operation will always be a 64-bit integer value, a double, or NaN.

  • Summing over zero documents or fields will result in 0L.
  • Summing over NaN will result in a double value representing NaN.
  • A sum that overflows the maximum representable 64-bit integer value will result in a double return value. This may result in lost precision of the result.
  • A sum that overflows the maximum representable double value will result in a double return value representing infinity.
Parameters
@NonNull FieldPath fieldPath

Specifies the field to sum across the result set.
Returns
@NonNull AggregateField.SumAggregateField

The `SumAggregateField` object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.