Filter

class Filter

A Filter represents a restriction on one or more field values and can be used to refine the results of a Query.

Summary

Public constructors
`Filter()`

Public functions
`java-static Filter`	`and(filters: Array<Filter!>!)` Creates a new filter that is a conjunction of the given filters.
`java-static Filter`	`arrayContains(field: String, value: Any?)` Creates a new filter for checking that the given array field contains the given value.
`java-static Filter`	`arrayContains(fieldPath: FieldPath, value: Any?)` Creates a new filter for checking that the given array field contains the given value.
`java-static Filter`	`arrayContainsAny(field: String, values: (Mutable)List<Any!>)` Creates a new filter for checking that the given array field contains any of the given values.
`java-static Filter`	`arrayContainsAny(fieldPath: FieldPath, values: (Mutable)List<Any!>)` Creates a new filter for checking that the given array field contains any of the given values.
`java-static Filter`	`equalTo(field: String, value: Any?)` Creates a new filter for checking that the given field is equal to the given value.
`java-static Filter`	`equalTo(fieldPath: FieldPath, value: Any?)` Creates a new filter for checking that the given field is equal to the given value.
`java-static Filter`	`greaterThan(field: String, value: Any?)` Creates a new filter for checking that the given field is greater than the given value.
`java-static Filter`	`greaterThan(fieldPath: FieldPath, value: Any?)` Creates a new filter for checking that the given field is greater than the given value.
`java-static Filter`	`greaterThanOrEqualTo(field: String, value: Any?)` Creates a new filter for checking that the given field is greater than or equal to the given value.
`java-static Filter`	`greaterThanOrEqualTo(fieldPath: FieldPath, value: Any?)` Creates a new filter for checking that the given field is greater than or equal to the given value.
`java-static Filter`	`inArray(field: String, values: (Mutable)List<Any!>)` Creates a new filter for checking that the given field equals any of the given values.
`java-static Filter`	`inArray(fieldPath: FieldPath, values: (Mutable)List<Any!>)` Creates a new filter for checking that the given field equals any of the given values.
`java-static Filter`	`lessThan(field: String, value: Any?)` Creates a new filter for checking that the given field is less than the given value.
`java-static Filter`	`lessThan(fieldPath: FieldPath, value: Any?)` Creates a new filter for checking that the given field is less than the given value.
`java-static Filter`	`lessThanOrEqualTo(field: String, value: Any?)` Creates a new filter for checking that the given field is less than or equal to the given value.
`java-static Filter`	`lessThanOrEqualTo(fieldPath: FieldPath, value: Any?)` Creates a new filter for checking that the given field is less than or equal to the given value.
`java-static Filter`	`notEqualTo(field: String, value: Any?)` Creates a new filter for checking that the given field is not equal to the given value.
`java-static Filter`	`notEqualTo(fieldPath: FieldPath, value: Any?)` Creates a new filter for checking that the given field is not equal to the given value.
`java-static Filter`	`notInArray(field: String, values: (Mutable)List<Any!>)` Creates a new filter for checking that the given field does not equal any of the given values.
`java-static Filter`	`notInArray(fieldPath: FieldPath, values: (Mutable)List<Any!>)` Creates a new filter for checking that the given field does not equal any of the given values.
`java-static Filter`	`or(filters: Array<Filter!>!)` Creates a new filter that is a disjunction of the given filters.

Public constructors

Filter

Filter()

Public functions

and

java-static fun and(filters: Array<Filter!>!): Filter

Creates a new filter that is a conjunction of the given filters. A conjunction filter includes a document if it satisfies all of the given filters.

Parameters
`filters: Array<Filter!>!`	The list of filters to perform a conjunction for.

Returns
`Filter`	The newly created filter.

arrayContains

java-static fun arrayContains(field: String, value: Any?): Filter

Creates a new filter for checking that the given array field contains the given value.

Parameters
`field: String`	The field used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

arrayContains

java-static fun arrayContains(fieldPath: FieldPath, value: Any?): Filter

Creates a new filter for checking that the given array field contains the given value.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

arrayContainsAny

java-static fun arrayContainsAny(field: String, values: (Mutable)List<Any!>): Filter

Creates a new filter for checking that the given array field contains any of the given values.

Parameters
`field: String`	The field used for the filter.
`values: (Mutable)List<Any!>`	The list of values used for the filter.

Returns
`Filter`	The newly created filter.

arrayContainsAny

java-static fun arrayContainsAny(fieldPath: FieldPath, values: (Mutable)List<Any!>): Filter

Creates a new filter for checking that the given array field contains any of the given values.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`values: (Mutable)List<Any!>`	The list of values used for the filter.

Returns
`Filter`	The newly created filter.

equalTo

java-static fun equalTo(field: String, value: Any?): Filter

Creates a new filter for checking that the given field is equal to the given value.

Parameters
`field: String`	The field used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

equalTo

java-static fun equalTo(fieldPath: FieldPath, value: Any?): Filter

Creates a new filter for checking that the given field is equal to the given value.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

greaterThan

java-static fun greaterThan(field: String, value: Any?): Filter

Creates a new filter for checking that the given field is greater than the given value.

Parameters
`field: String`	The field used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

greaterThan

java-static fun greaterThan(fieldPath: FieldPath, value: Any?): Filter

Creates a new filter for checking that the given field is greater than the given value.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

greaterThanOrEqualTo

java-static fun greaterThanOrEqualTo(field: String, value: Any?): Filter

Creates a new filter for checking that the given field is greater than or equal to the given value.

Parameters
`field: String`	The field used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

greaterThanOrEqualTo

java-static fun greaterThanOrEqualTo(fieldPath: FieldPath, value: Any?): Filter

Creates a new filter for checking that the given field is greater than or equal to the given value.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

inArray

java-static fun inArray(field: String, values: (Mutable)List<Any!>): Filter

Creates a new filter for checking that the given field equals any of the given values.

Parameters
`field: String`	The field used for the filter.
`values: (Mutable)List<Any!>`	The list of values used for the filter.

Returns
`Filter`	The newly created filter.

inArray

java-static fun inArray(fieldPath: FieldPath, values: (Mutable)List<Any!>): Filter

Creates a new filter for checking that the given field equals any of the given values.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`values: (Mutable)List<Any!>`	The list of values used for the filter.

Returns
`Filter`	The newly created filter.

lessThan

java-static fun lessThan(field: String, value: Any?): Filter

Creates a new filter for checking that the given field is less than the given value.

Parameters
`field: String`	The field used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

lessThan

java-static fun lessThan(fieldPath: FieldPath, value: Any?): Filter

Creates a new filter for checking that the given field is less than the given value.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

lessThanOrEqualTo

java-static fun lessThanOrEqualTo(field: String, value: Any?): Filter

Creates a new filter for checking that the given field is less than or equal to the given value.

Parameters
`field: String`	The field used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

lessThanOrEqualTo

java-static fun lessThanOrEqualTo(fieldPath: FieldPath, value: Any?): Filter

Creates a new filter for checking that the given field is less than or equal to the given value.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

notEqualTo

java-static fun notEqualTo(field: String, value: Any?): Filter

Creates a new filter for checking that the given field is not equal to the given value.

Parameters
`field: String`	The field used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

notEqualTo

java-static fun notEqualTo(fieldPath: FieldPath, value: Any?): Filter

Creates a new filter for checking that the given field is not equal to the given value.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`value: Any?`	The value used for the filter.

Returns
`Filter`	The newly created filter.

notInArray

java-static fun notInArray(field: String, values: (Mutable)List<Any!>): Filter

Creates a new filter for checking that the given field does not equal any of the given values.

Parameters
`field: String`	The field path used for the filter.
`values: (Mutable)List<Any!>`	The list of values used for the filter.

Returns
`Filter`	The newly created filter.

notInArray

java-static fun notInArray(fieldPath: FieldPath, values: (Mutable)List<Any!>): Filter

Creates a new filter for checking that the given field does not equal any of the given values.

Parameters
`fieldPath: FieldPath`	The field path used for the filter.
`values: (Mutable)List<Any!>`	The list of values used for the filter.

Returns
`Filter`	The newly created filter.

or

java-static fun or(filters: Array<Filter!>!): Filter

Creates a new filter that is a disjunction of the given filters. A disjunction filter includes a document if it satisfies any of the given filters.

Parameters
`filters: Array<Filter!>!`	The list of filters to perform a disjunction for.

Returns
`Filter`	The newly created filter.