Class Filter (3.21.0)

public class Filter

Inheritance

Object > Filter

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

and(Filter[] filters)

public static Filter and(Filter[] filters)

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.

Parameter
Name	Description
`filters`	`Filter[]` The list of filters to perform a conjunction for.

Returns
Type	Description
`Filter`	The newly created filter.

arrayContains(FieldPath fieldPath, Object value)

public static Filter arrayContains(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

arrayContains(String field, Object value)

public static Filter arrayContains(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

arrayContainsAny(FieldPath fieldPath, Object value)

public static Filter arrayContainsAny(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The list of values used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

arrayContainsAny(String field, Object value)

public static Filter arrayContainsAny(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The list of values used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

equalTo(FieldPath fieldPath, Object value)

public static Filter equalTo(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

equalTo(String field, Object value)

public static Filter equalTo(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

greaterThan(FieldPath fieldPath, Object value)

public static Filter greaterThan(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

greaterThan(String field, Object value)

public static Filter greaterThan(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

greaterThanOrEqualTo(FieldPath fieldPath, Object value)

public static Filter greaterThanOrEqualTo(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

greaterThanOrEqualTo(String field, Object value)

public static Filter greaterThanOrEqualTo(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

inArray(FieldPath fieldPath, Object value)

public static Filter inArray(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The list of values used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

inArray(String field, Object value)

public static Filter inArray(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The list of values used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

lessThan(FieldPath fieldPath, Object value)

public static Filter lessThan(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

lessThan(String field, Object value)

public static Filter lessThan(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

lessThanOrEqualTo(FieldPath fieldPath, Object value)

public static Filter lessThanOrEqualTo(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

lessThanOrEqualTo(String field, Object value)

public static Filter lessThanOrEqualTo(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

notEqualTo(FieldPath fieldPath, Object value)

public static Filter notEqualTo(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

notEqualTo(String field, Object value)

public static Filter notEqualTo(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field used for the filter.
`value`	`Object` The value used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

notInArray(FieldPath fieldPath, Object value)

public static Filter notInArray(FieldPath fieldPath, Object value)

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

Parameters
Name	Description
`fieldPath`	`FieldPath` The field path used for the filter.
`value`	`Object` The list of values used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

notInArray(String field, Object value)

public static Filter notInArray(String field, Object value)

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

Parameters
Name	Description
`field`	`String` The field path used for the filter.
`value`	`Object` The list of values used for the filter.

Returns
Type	Description
`Filter`	The newly created filter.

or(Filter[] filters)

public static Filter or(Filter[] filters)

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.

Parameter
Name	Description
`filters`	`Filter[]` The list of filters to perform a disjunction for.

Returns
Type	Description
`Filter`	The newly created filter.

Constructors

Filter()

public Filter()