Filters (mongo-java-driver 3.0.0 API)

java.lang.Object
- com.mongodb.client.model.Filters

```
public final class Filters
extends Object
```
A factory for query filters. A convenient way to use this class is to statically import all of its methods, which allows usage like:
```
    collection.find(and(eq("x", 1), lt("y", 3)));
 
```
Since:

3.0

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <TItem> Bson`	`all(String fieldName, Iterable<TItem> values)` Creates a filter that matches all documents where the value of a field is an array that contains all the specified values.
`static <TItem> Bson`	`all(String fieldName, TItem... values)` Creates a filter that matches all documents where the value of a field is an array that contains all the specified values.
`static Bson`	`and(Bson... filters)` Creates a filter that performs a logical AND of the provided list of filters.
`static Bson`	`and(Iterable<Bson> filters)` Creates a filter that performs a logical AND of the provided list of filters.
`static Bson`	`elemMatch(String fieldName, Bson filter)` Creates a filter that matches all documents containing a field that is an array where at least one member of the array matches the given filter.
`static <TItem> Bson`	`eq(String fieldName, TItem value)` Creates a filter that matches all documents where the value of the field name equals the specified value.
`static Bson`	`exists(String fieldName)` Creates a filter that matches all documents that contain the given field.
`static Bson`	`exists(String fieldName, boolean exists)` Creates a filter that matches all documents that either contain or do not contain the given field, depending on the value of the exists parameter.
`static <TItem> Bson`	`gt(String fieldName, TItem value)` Creates a filter that matches all documents where the value of the given field is greater than the specified value.
`static <TItem> Bson`	`gte(String fieldName, TItem value)` Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
`static <TItem> Bson`	`in(String fieldName, Iterable<TItem> values)` Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
`static <TItem> Bson`	`in(String fieldName, TItem... values)` Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
`static <TItem> Bson`	`lt(String fieldName, TItem value)` Creates a filter that matches all documents where the value of the given field is less than the specified value.
`static <TItem> Bson`	`lte(String fieldName, TItem value)` Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
`static Bson`	`mod(String fieldName, long divisor, long remainder)` Creates a filter that matches all documents where the value of a field divided by a divisor has the specified remainder (i.e.
`static <TItem> Bson`	`ne(String fieldName, TItem value)` Creates a filter that matches all documents where the value of the field name does not equal the specified value.
`static <TItem> Bson`	`nin(String fieldName, Iterable<TItem> values)` Creates a filter that matches all documents where the value of a field does not equal any of the specified values or does not exist.
`static <TItem> Bson`	`nin(String fieldName, TItem... values)` Creates a filter that matches all documents where the value of a field does not equal any of the specified values or does not exist.
`static Bson`	`nor(Bson... filters)` Creates a filter that performs a logical NOR operation on all the specified filters.
`static Bson`	`nor(Iterable<Bson> filters)` Creates a filter that performs a logical NOR operation on all the specified filters.
`static Bson`	`not(Bson filter)` Creates a filter that matches all documents that do not match the passed in filter.
`static Bson`	`or(Bson... filters)` Creates a filter that preforms a logical OR of the provided list of filters.
`static Bson`	`or(Iterable<Bson> filters)` Creates a filter that preforms a logical OR of the provided list of filters.
`static Bson`	`regex(String fieldName, Pattern pattern)` Creates a filter that matches all documents where the value of the field matches the given regular expression pattern with the given options applied.
`static Bson`	`regex(String fieldName, String pattern)` Creates a filter that matches all documents where the value of the field matches the given regular expression pattern with the given options applied.
`static Bson`	`regex(String fieldName, String pattern, String options)` Creates a filter that matches all documents where the value of the field matches the given regular expression pattern with the given options applied.
`static Bson`	`size(String fieldName, int size)` Creates a filter that matches all documents where the value of a field is an array of the specified size.
`static Bson`	`text(String search)` Creates a filter that matches all documents matching the given search term.
`static Bson`	`text(String search, String language)` Creates a filter that matches all documents matching the given search term using the given language.
`static Bson`	`type(String fieldName, BsonType type)` Creates a filter that matches all documents where the value of the field is of the specified BSON type.
`static Bson`	`where(String javaScriptExpression)` Creates a filter that matches all documents for which the given expression is true.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - eq
```
public static <TItem> Bson eq(String fieldName,
                              TItem value)
```
    Creates a filter that matches all documents where the value of the field name equals the specified value. Note that this does actually generate a $eq operator, as the query language doesn't require it.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    value - the value
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $eq
  - ne
```
public static <TItem> Bson ne(String fieldName,
                              TItem value)
```
    Creates a filter that matches all documents where the value of the field name does not equal the specified value.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    value - the value
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $ne
  - gt
```
public static <TItem> Bson gt(String fieldName,
                              TItem value)
```
    Creates a filter that matches all documents where the value of the given field is greater than the specified value.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    value - the value
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $gt
  - lt
```
public static <TItem> Bson lt(String fieldName,
                              TItem value)
```
    Creates a filter that matches all documents where the value of the given field is less than the specified value.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    value - the value
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $lt
  - gte
```
public static <TItem> Bson gte(String fieldName,
                               TItem value)
```
    Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    value - the value
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $gte
  - lte
```
public static <TItem> Bson lte(String fieldName,
                               TItem value)
```
    Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    value - the value
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $lte
  - in
```
public static <TItem> Bson in(String fieldName,
                              TItem... values)
```
    Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    values - the list of values
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $in
  - in
```
public static <TItem> Bson in(String fieldName,
                              Iterable<TItem> values)
```
    Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    values - the list of values
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $in
  - nin
```
public static <TItem> Bson nin(String fieldName,
                               TItem... values)
```
    Creates a filter that matches all documents where the value of a field does not equal any of the specified values or does not exist.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    values - the list of values
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $nin
  - nin
```
public static <TItem> Bson nin(String fieldName,
                               Iterable<TItem> values)
```
    Creates a filter that matches all documents where the value of a field does not equal any of the specified values or does not exist.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    values - the list of values
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $nin
  - and
```
public static Bson and(Iterable<Bson> filters)
```
    Creates a filter that performs a logical AND of the provided list of filters. Note that this will only generate a "$and" operator if absolutely necessary, as the query language implicity ands together all the keys. In other words, a query expression like:
    and(eq("x", 1), lt("y", 3))
    will generate a MongoDB query like:
    {x : 1, y : {$lt : 3}}
    Parameters:
    
    filters - the list of filters to and together
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $and
  - and
```
public static Bson and(Bson... filters)
```
    Creates a filter that performs a logical AND of the provided list of filters. Note that this will only generate a "$and" operator if absolutely necessary, as the query language implicity ands together all the keys. In other words, a query expression like:
    and(eq("x", 1), lt("y", 3))
    will generate a MongoDB query like:
    {x : 1, y : {$lt : 3}}
    Parameters:
    
    filters - the list of filters to and together
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $and
  - or
```
public static Bson or(Iterable<Bson> filters)
```
    Creates a filter that preforms a logical OR of the provided list of filters.
    
    Parameters:
    
    filters - the list of filters to and together
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $or
  - or
```
public static Bson or(Bson... filters)
```
    Creates a filter that preforms a logical OR of the provided list of filters.
    
    Parameters:
    
    filters - the list of filters to and together
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $or
  - not
```
public static Bson not(Bson filter)
```
    Creates a filter that matches all documents that do not match the passed in filter. Requires the field name to passed as part of the value passed in and lifts it to create a valid "$not" query:
    not(eq("x", 1))
    will generate a MongoDB query like:
    {x : $not: {$eq : 1}}
    Parameters:
    
    filter - the value
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $not
  - nor
```
public static Bson nor(Bson... filters)
```
    Creates a filter that performs a logical NOR operation on all the specified filters.
    
    Parameters:
    
    filters - the list of values
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $nor
  - nor
```
public static Bson nor(Iterable<Bson> filters)
```
    Creates a filter that performs a logical NOR operation on all the specified filters.
    
    Parameters:
    
    filters - the list of values
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $nor
  - exists
```
public static Bson exists(String fieldName)
```
    Creates a filter that matches all documents that contain the given field.
    
    Parameters:
    
    fieldName - the field name
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $exists
  - exists
```
public static Bson exists(String fieldName,
                          boolean exists)
```
    Creates a filter that matches all documents that either contain or do not contain the given field, depending on the value of the exists parameter.
    
    Parameters:
    
    fieldName - the field name
    
    exists - true to check for existence, false to check for absence
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $exists
  - type
```
public static Bson type(String fieldName,
                        BsonType type)
```
    Creates a filter that matches all documents where the value of the field is of the specified BSON type.
    
    Parameters:
    
    fieldName - the field name
    
    type - the BSON type
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $type
  - mod
```
public static Bson mod(String fieldName,
                       long divisor,
                       long remainder)
```
    Creates a filter that matches all documents where the value of a field divided by a divisor has the specified remainder (i.e. perform a modulo operation to select documents).
    
    Parameters:
    
    fieldName - the field name
    
    divisor - the modulus
    
    remainder - the remainder
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $mod
  - regex
```
public static Bson regex(String fieldName,
                         String pattern)
```
    Creates a filter that matches all documents where the value of the field matches the given regular expression pattern with the given options applied.
    
    Parameters:
    
    fieldName - the field name
    
    pattern - the pattern
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $regex
  - regex
```
public static Bson regex(String fieldName,
                         String pattern,
                         String options)
```
    Creates a filter that matches all documents where the value of the field matches the given regular expression pattern with the given options applied.
    
    Parameters:
    
    fieldName - the field name
    
    pattern - the pattern
    
    options - the options
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $regex
  - regex
```
public static Bson regex(String fieldName,
                         Pattern pattern)
```
    Creates a filter that matches all documents where the value of the field matches the given regular expression pattern with the given options applied.
    
    Parameters:
    
    fieldName - the field name
    
    pattern - the pattern
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $regex
  - text
```
public static Bson text(String search)
```
    Creates a filter that matches all documents matching the given search term.
    
    Parameters:
    
    search - the search term
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $text
  - text
```
public static Bson text(String search,
                        String language)
```
    Creates a filter that matches all documents matching the given search term using the given language.
    
    Parameters:
    
    search - the search term
    
    language - the language to use for stop words
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $text
  - where
```
public static Bson where(String javaScriptExpression)
```
    Creates a filter that matches all documents for which the given expression is true.
    
    Parameters:
    
    javaScriptExpression - the JavaScript expression
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $where
  - all
```
public static <TItem> Bson all(String fieldName,
                               TItem... values)
```
    Creates a filter that matches all documents where the value of a field is an array that contains all the specified values.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    values - the list of values
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $all
  - all
```
public static <TItem> Bson all(String fieldName,
                               Iterable<TItem> values)
```
    Creates a filter that matches all documents where the value of a field is an array that contains all the specified values.
    
    Type Parameters:
    
    TItem - the value type
    
    Parameters:
    
    fieldName - the field name
    
    values - the list of values
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $all
  - elemMatch
```
public static Bson elemMatch(String fieldName,
                             Bson filter)
```
    Creates a filter that matches all documents containing a field that is an array where at least one member of the array matches the given filter.
    
    Parameters:
    
    fieldName - the field name
    
    filter - the filter to apply to each element
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $elemMatch
  - size
```
public static Bson size(String fieldName,
                        int size)
```
    Creates a filter that matches all documents where the value of a field is an array of the specified size.
    
    Parameters:
    
    fieldName - the field name
    
    size - the size of the array
    
    Returns:
    
    the filter
    
    MongoDB documentation
    
    $size

Class Filters

Method Summary

Methods inherited from class java.lang.Object

Method Detail

eq

ne

gt

lt

gte

lte

in

in

nin

nin

and

and

or

or

not

nor

nor

exists

exists

type

mod

regex

regex

regex

text

text

where

all

all

elemMatch

size