Filter
public classFilter
AFilter represents a restriction on one or more field values and can be used to refine the results of aQuery.
Summary
Public constructors |
|---|
Filter() |
Public methods | |
|---|---|
static @NonNullFilter | and(Filter[] filters)Creates a new filter that is a conjunction of the given filters. |
static @NonNullFilter | arrayContains(@NonNullString field, @NullableObject value)Creates a new filter for checking that the given array field contains the given value. |
static @NonNullFilter | arrayContains(@NonNullFieldPath fieldPath, @NullableObject value)Creates a new filter for checking that the given array field contains the given value. |
static @NonNullFilter | Creates a new filter for checking that the given array field contains any of the given values. |
static @NonNullFilter | Creates a new filter for checking that the given array field contains any of the given values. |
static @NonNullFilter | Creates a new filter for checking that the given field is equal to the given value. |
static @NonNullFilter | Creates a new filter for checking that the given field is equal to the given value. |
static @NonNullFilter | greaterThan(@NonNullString field, @NullableObject value)Creates a new filter for checking that the given field is greater than the given value. |
static @NonNullFilter | greaterThan(@NonNullFieldPath fieldPath, @NullableObject value)Creates a new filter for checking that the given field is greater than the given value. |
static @NonNullFilter | greaterThanOrEqualTo(@NonNullString field, @NullableObject value)Creates a new filter for checking that the given field is greater than or equal to the given value. |
static @NonNullFilter | greaterThanOrEqualTo(@NonNullFieldPath fieldPath, @NullableObject value)Creates a new filter for checking that the given field is greater than or equal to the given value. |
static @NonNullFilter | Creates a new filter for checking that the given field equals any of the given values. |
static @NonNullFilter | Creates a new filter for checking that the given field equals any of the given values. |
static @NonNullFilter | Creates a new filter for checking that the given field is less than the given value. |
static @NonNullFilter | Creates a new filter for checking that the given field is less than the given value. |
static @NonNullFilter | lessThanOrEqualTo(@NonNullString field, @NullableObject value)Creates a new filter for checking that the given field is less than or equal to the given value. |
static @NonNullFilter | lessThanOrEqualTo(@NonNullFieldPath fieldPath, @NullableObject value)Creates a new filter for checking that the given field is less than or equal to the given value. |
static @NonNullFilter | notEqualTo(@NonNullString field, @NullableObject value)Creates a new filter for checking that the given field is not equal to the given value. |
static @NonNullFilter | notEqualTo(@NonNullFieldPath fieldPath, @NullableObject value)Creates a new filter for checking that the given field is not equal to the given value. |
static @NonNullFilter | Creates a new filter for checking that the given field does not equal any of the given values. |
static @NonNullFilter | Creates a new filter for checking that the given field does not equal any of the given values. |
static @NonNullFilter | or(Filter[] filters)Creates a new filter that is a disjunction of the given filters. |
Public constructors
Public methods
and
public static @NonNullFilter and(Filter[] filters)
Creates a new filter that is a conjunction of the given filters. A conjunction filter includes a document if it satisfiesall of the given filters.
| Parameters | |
|---|---|
Filter[] filters | The list of filters to perform a conjunction for. |
arrayContains
public static @NonNullFilter arrayContains(@NonNullString field, @NullableObject value)
Creates a new filter for checking that the given array field contains the given value.
arrayContains
public static @NonNullFilter arrayContains(@NonNullFieldPath fieldPath, @NullableObject value)
Creates a new filter for checking that the given array field contains the given value.
arrayContainsAny
public static @NonNullFilter arrayContainsAny(@NonNullString field, @NonNullList<Object> values)
Creates a new filter for checking that the given array field contains any of the given values.
arrayContainsAny
public static @NonNullFilter arrayContainsAny(
@NonNullFieldPath fieldPath,
@NonNullList<Object> values
)
Creates a new filter for checking that the given array field contains any of the given values.
equalTo
public static @NonNullFilter equalTo(@NonNullString field, @NullableObject value)
Creates a new filter for checking that the given field is equal to the given value.
equalTo
public static @NonNullFilter equalTo(@NonNullFieldPath fieldPath, @NullableObject value)
Creates a new filter for checking that the given field is equal to the given value.
greaterThan
public static @NonNullFilter greaterThan(@NonNullString field, @NullableObject value)
Creates a new filter for checking that the given field is greater than the given value.
greaterThan
public static @NonNullFilter greaterThan(@NonNullFieldPath fieldPath, @NullableObject value)
Creates a new filter for checking that the given field is greater than the given value.
greaterThanOrEqualTo
public static @NonNullFilter greaterThanOrEqualTo(@NonNullString field, @NullableObject value)
Creates a new filter for checking that the given field is greater than or equal to the given value.
greaterThanOrEqualTo
public static @NonNullFilter greaterThanOrEqualTo(@NonNullFieldPath fieldPath, @NullableObject value)
Creates a new filter for checking that the given field is greater than or equal to the given value.
inArray
public static @NonNullFilter inArray(@NonNullString field, @NonNullList<Object> values)
Creates a new filter for checking that the given field equals any of the given values.
inArray
public static @NonNullFilter inArray(@NonNullFieldPath fieldPath, @NonNullList<Object> values)
Creates a new filter for checking that the given field equals any of the given values.
lessThan
public static @NonNullFilter lessThan(@NonNullString field, @NullableObject value)
Creates a new filter for checking that the given field is less than the given value.
lessThan
public static @NonNullFilter lessThan(@NonNullFieldPath fieldPath, @NullableObject value)
Creates a new filter for checking that the given field is less than the given value.
lessThanOrEqualTo
public static @NonNullFilter lessThanOrEqualTo(@NonNullString field, @NullableObject value)
Creates a new filter for checking that the given field is less than or equal to the given value.
lessThanOrEqualTo
public static @NonNullFilter lessThanOrEqualTo(@NonNullFieldPath fieldPath, @NullableObject value)
Creates a new filter for checking that the given field is less than or equal to the given value.
notEqualTo
public static @NonNullFilter notEqualTo(@NonNullString field, @NullableObject value)
Creates a new filter for checking that the given field is not equal to the given value.
notEqualTo
public static @NonNullFilter notEqualTo(@NonNullFieldPath fieldPath, @NullableObject value)
Creates a new filter for checking that the given field is not equal to the given value.
notInArray
public static @NonNullFilter notInArray(@NonNullString field, @NonNullList<Object> values)
Creates a new filter for checking that the given field does not equal any of the given values.
notInArray
public static @NonNullFilter notInArray(@NonNullFieldPath fieldPath, @NonNullList<Object> values)
Creates a new filter for checking that the given field does not equal any of the given values.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-21 UTC.